-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #366 from serverlessworkflow/1.0.0-alpha1
DSL v1.0.0-alpha1
- Loading branch information
Showing
4,159 changed files
with
104,458 additions
and
146,438 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
|
||
[*.{cs,vb}] | ||
#### Naming styles #### | ||
|
||
# Naming rules | ||
|
||
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion | ||
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface | ||
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i | ||
|
||
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion | ||
dotnet_naming_rule.types_should_be_pascal_case.symbols = types | ||
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case | ||
|
||
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion | ||
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members | ||
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case | ||
|
||
# Symbol specifications | ||
|
||
dotnet_naming_symbols.interface.applicable_kinds = interface | ||
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | ||
dotnet_naming_symbols.interface.required_modifiers = | ||
|
||
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum | ||
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | ||
dotnet_naming_symbols.types.required_modifiers = | ||
|
||
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method | ||
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected | ||
dotnet_naming_symbols.non_field_members.required_modifiers = | ||
|
||
# Naming styles | ||
|
||
dotnet_naming_style.begins_with_i.required_prefix = I | ||
dotnet_naming_style.begins_with_i.required_suffix = | ||
dotnet_naming_style.begins_with_i.word_separator = | ||
dotnet_naming_style.begins_with_i.capitalization = pascal_case | ||
|
||
dotnet_naming_style.pascal_case.required_prefix = | ||
dotnet_naming_style.pascal_case.required_suffix = | ||
dotnet_naming_style.pascal_case.word_separator = | ||
dotnet_naming_style.pascal_case.capitalization = pascal_case | ||
|
||
dotnet_naming_style.pascal_case.required_prefix = | ||
dotnet_naming_style.pascal_case.required_suffix = | ||
dotnet_naming_style.pascal_case.word_separator = | ||
dotnet_naming_style.pascal_case.capitalization = pascal_case | ||
dotnet_style_operator_placement_when_wrapping = beginning_of_line | ||
tab_width = 4 | ||
indent_size = 4 | ||
end_of_line = crlf | ||
dotnet_style_coalesce_expression = true:suggestion | ||
dotnet_style_null_propagation = true:suggestion | ||
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion | ||
dotnet_style_prefer_auto_properties = true:silent | ||
dotnet_style_object_initializer = true:suggestion | ||
dotnet_style_collection_initializer = true:suggestion | ||
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion | ||
dotnet_style_prefer_conditional_expression_over_assignment = true:silent | ||
dotnet_style_prefer_conditional_expression_over_return = true:silent | ||
dotnet_style_explicit_tuple_names = true:suggestion | ||
dotnet_style_prefer_inferred_tuple_names = true:suggestion | ||
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion | ||
dotnet_style_prefer_compound_assignment = true:suggestion | ||
dotnet_style_prefer_simplified_interpolation = true:suggestion | ||
dotnet_style_namespace_match_folder = true:suggestion | ||
dotnet_style_readonly_field = true:suggestion | ||
|
||
[*.cs] | ||
csharp_indent_labels = one_less_than_current | ||
csharp_space_around_binary_operators = before_and_after | ||
csharp_using_directive_placement = outside_namespace:silent | ||
csharp_prefer_simple_using_statement = true:suggestion | ||
csharp_prefer_braces = true:silent | ||
csharp_style_namespace_declarations = block_scoped:silent | ||
csharp_style_prefer_method_group_conversion = true:silent | ||
csharp_style_prefer_top_level_statements = true:silent | ||
csharp_style_expression_bodied_methods = false:silent | ||
csharp_style_expression_bodied_constructors = false:silent | ||
csharp_style_expression_bodied_operators = false:silent | ||
csharp_style_expression_bodied_properties = true:silent | ||
csharp_style_expression_bodied_indexers = true:silent | ||
csharp_style_expression_bodied_accessors = true:silent | ||
csharp_style_expression_bodied_lambdas = true:silent | ||
csharp_style_expression_bodied_local_functions = false:silent | ||
csharp_style_throw_expression = true:suggestion | ||
csharp_style_prefer_null_check_over_type_check = true:suggestion | ||
csharp_prefer_simple_default_expression = true:suggestion | ||
csharp_style_prefer_local_over_anonymous_function = true:suggestion | ||
csharp_style_prefer_index_operator = true:suggestion | ||
csharp_style_prefer_range_operator = true:suggestion | ||
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion | ||
csharp_style_prefer_tuple_swap = true:suggestion | ||
csharp_style_prefer_utf8_string_literals = true:suggestion | ||
csharp_style_inlined_variable_declaration = true:suggestion | ||
csharp_style_deconstructed_variable_declaration = true:suggestion | ||
csharp_style_unused_value_assignment_preference = discard_variable:suggestion | ||
csharp_style_unused_value_expression_statement_preference = discard_variable:silent | ||
|
||
file_header_template = Copyright © 2024-Present The Synapse Authors\n\nLicensed under the Apache License, Version 2.0 (the "License"),\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an "AS IS" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Code of Conduct | ||
|
||
This community adheres to the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
|
||
To report any violations of the Code of Conduct, please contact the [CNCF Code of Conduct Committee](mailto:[email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,91 +1,29 @@ | ||
# Contributing to Synapse | ||
# Contributing | ||
|
||
This page contains information about reporting issues, how to suggest changes as | ||
well as the guidelines we follow for how our documents are formatted. | ||
Thank you for considering contributing to the Synapse project! Your contributions help improve the project and are greatly appreciated. Please follow the guidelines below to ensure a smooth and effective contribution process. | ||
|
||
## Table of Contents | ||
## How to Contribute | ||
|
||
- [Reporting an Issue](#reporting-an-issue) | ||
- [Suggesting a Change](#suggesting-a-change) | ||
- [Spec Formatting Conventions](#spec-formatting-conventions) | ||
### Reporting Issues | ||
|
||
## Reporting an Issue | ||
If you encounter any bugs or have suggestions for improvements, please report them using GitHub Issues: | ||
|
||
To report an issue, or to suggest an idea for a change that you haven't had time | ||
to write-up yet, open an [issue](https://github.com/serverlessworkflow/synapse/issues). It | ||
is best to check our existing | ||
[issues](https://github.com/serverlessworkflow/synapse/issues) first to see if a similar | ||
one has already been opened and discussed. | ||
1. Go to the [Issues page](https://github.com/serverlessworkflow/synapse/issues) of the repository. | ||
2. Check if the issue has already been reported. If not, click on "New issue". | ||
3. Provide a clear and concise description of the problem or suggestion. Include any relevant details or screenshots. | ||
|
||
## Suggesting a Change | ||
### Suggesting Enhancements | ||
|
||
To suggest a change to this repository, submit a | ||
[pull request](https://github.com/serverlessworkflow/synapse/pulls) (PR) with the complete | ||
set of changes you'd like to see. See the | ||
[Spec Formatting Conventions](#spec-formatting-conventions) section for the | ||
guidelines we follow for how documents are formatted. | ||
If you have ideas for new features or enhancements: | ||
|
||
Each PR must be signed per the following section. | ||
1. Open a new issue on the [Issues page](https://github.com/serverlessworkflow/synapse/issues). | ||
2. Clearly describe the enhancement or feature request and explain why it would be valuable. | ||
|
||
### Assigning and Owning work | ||
### Submitting Pull Requests | ||
|
||
If you want to own and work on an issue, add a comment or “#dibs” it asking | ||
about ownership. A maintainer will then add the Assigned label and modify the | ||
first comment in the issue to include `Assigned to: @person` | ||
To contribute code changes, please follow these steps: | ||
|
||
## Spec Formatting Conventions | ||
|
||
Documents in this repository will adhere to the following rules: | ||
|
||
- Lines are wrapped at 80 columns (when possible) | ||
- Specifications will use [RFC2119](https://tools.ietf.org/html/rfc2119) | ||
keywords to indicate normative requirements | ||
|
||
## Checks | ||
|
||
### Markdown style | ||
|
||
Markdown files should be properly formatted before a pull request is sent out. | ||
In this repository we follow the | ||
[markdownlint rules](https://github.com/DavidAnson/markdownlint#rules--aliases) | ||
with some customizations. See [markdownlint](.markdownlint.yaml) or | ||
[settings](.vscode/settings.json) for details. | ||
|
||
We highly encourage to use line breaks in markdown files at `80` characters | ||
wide. There are tools that can do it for you effectively. Please submit proposal | ||
to include your editor settings required to enable this behavior so the out of | ||
the box settings for this repository will be consistent. | ||
|
||
If you are using Visual Studio Code, | ||
you can also use the `fixAll` command of the | ||
[vscode markdownlint extension](https://github.com/DavidAnson/vscode-markdownlint). | ||
|
||
To otherwise check for style violations, use | ||
|
||
```bash | ||
# Ruby and gem are required for mdl | ||
gem install mdl | ||
mdl -c .mdlrc . | ||
``` | ||
|
||
To fix style violations, follow the | ||
[instruction](https://github.com/DavidAnson/markdownlint#optionsresultversion) | ||
with the Node version of markdownlint. | ||
|
||
### Typos | ||
|
||
In addition, please make sure to clean up typos before you submit the change. | ||
|
||
To check for typos, you may use | ||
|
||
```bash | ||
# Golang is needed for the misspell tool. | ||
make install-misspell | ||
make misspell | ||
``` | ||
|
||
To quickly fix typos, use | ||
|
||
```bash | ||
make misspell-correction | ||
``` | ||
1. **Fork the repository**: Create a personal fork of the repository on GitHub. | ||
2. **Clone your fork**: Clone the forked repository to your local machine. | ||
```bash | ||
git clone https://github.com/<your-username>/synapse.git |
Oops, something went wrong.