-
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.
fix(Solution): Added and updated the project's documents (following G…
…H community standards) feat(Solution): Added a new README file used to describe the project's community
- Loading branch information
Showing
11 changed files
with
196 additions
and
263 deletions.
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,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 |
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,138 +1,94 @@ | ||
| # Synapse Project Governance | ||
| # Governance | ||
|
|
||
| As a CNCF member project, we abide by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). | ||
| As a CNCF member project, Synapse adheres to the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). | ||
|
|
||
| For specific guidance on practical contribution steps for any Synapse sub-project please | ||
| see our [contributing guide](CONTRIBUTING.md). | ||
| For specific guidance on contributing to Synapse, please refer to our [contributing guide](contributing.md). | ||
|
|
||
| You can contact the project maintainers at any time by sending an email to the | ||
| [Synapse WMS Maintainers](mailto:[email protected]) | ||
| mailing list. | ||
| For any questions or concerns, contact the project maintainers via the [Serverless Workflow Specification Maintainers](mailto:[email protected]) mailing list. | ||
|
|
||
| ## Maintainership | ||
|
|
||
| Main responsibilities of maintainers include: | ||
| ### Responsibilities | ||
|
|
||
| 1) They share responsibility in the project's success. | ||
| 2) They have made a long-term, recurring time investment to improve the project. | ||
| 3) They spend that time doing whatever needs to be done, not necessarily what | ||
| is the most interesting or fun. | ||
| Maintainers are responsible for: | ||
|
|
||
| 1. Ensuring the project's overall success. | ||
| 2. Committing significant time and effort to enhance the project. | ||
| 3. Handling necessary tasks, even those that may not be the most engaging. | ||
|
|
||
| ## Reviewers | ||
|
|
||
| A reviewer is a core role within the project. | ||
| They share in reviewing issues and pull requests. Their pull request approvals | ||
| are needed to merge a large code change into the project. | ||
|
|
||
| ## Adding maintainers | ||
|
|
||
| Maintainers are first and foremost contributors that have shown they are | ||
| committed to the long term success of a project. Contributors wanting to become | ||
| maintainers are expected to be deeply involved in contributing code, pull | ||
| request review, and triage of issues in the project for more than three months. | ||
|
|
||
| Just contributing does not make you a maintainer, it is about building trust | ||
| with the current maintainers of the project and being a person that they can | ||
| depend on and trust to make decisions in the best interest of the project. | ||
|
|
||
| Periodically, the existing maintainers curate a list of contributors that have | ||
| shown regular activity on the project over the prior months. From this list, | ||
| maintainer candidates are selected and proposed on the project mailing list. | ||
|
|
||
| After a candidate has been announced on the project mailing list, the | ||
| existing maintainers are given fourteen business days to discuss the candidate, | ||
| raise objections and cast their vote. Votes may take place on the mailing list | ||
| or via pull request comment. Candidates must be approved by at least 66% of the | ||
| current maintainers by adding their vote on the mailing list. The reviewer role | ||
| has the same process but only requires 33% of current maintainers. Only | ||
| maintainers of the repository that the candidate is proposed for are allowed to | ||
| vote. | ||
|
|
||
| If a candidate is approved, a maintainer will contact the candidate to invite | ||
| the candidate to open a pull request that adds the contributor to the | ||
| [MAINTAINERS](MAINTAINERS.md) file. The voting process may take place inside a pull request if a | ||
| maintainer has already discussed the candidacy with the candidate and a | ||
| maintainer is willing to be a sponsor by opening the pull request. The candidate | ||
| becomes a maintainer once the pull request is merged. | ||
| Reviewers play a crucial role by: | ||
|
|
||
| ## Subprojects | ||
| - Reviewing and approving issues and pull requests. | ||
| - Approving pull requests is necessary for code changes to be merged into the project. | ||
|
|
||
| ## Emeritus Maintainers | ||
|
|
||
| Synapse subprojects all culminate in officially supported and maintained releases | ||
| of the specification. | ||
| All subprojects must adhere to [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) | ||
| as well as this governance document. | ||
| Emeritus maintainers are former maintainers who have significantly contributed to the project but are no longer able to be actively involved. They continue to: | ||
|
|
||
| ### Adding core subprojects | ||
| 1. Provide guidance and mentorship to current maintainers and contributors. | ||
| 2. Offer historical context and insights based on their past experiences. | ||
| 3. Participate in discussions and reviews on an advisory basis. | ||
|
|
||
| New subprojects can request to be added to the Synapse GitHub | ||
| organization by submitting a GitHub issue in the specification repository. | ||
| ## Adding Maintainers | ||
|
|
||
| The existing maintainers are given fourteen business days to discuss the new | ||
| project, raise objections and cast their vote. Projects must be approved by at | ||
| least 66% of the current maintainers. | ||
| To add a new maintainer: | ||
|
|
||
| If a project is approved, a maintainer will add the project to the Synapse | ||
| GitHub organization, and make an announcement on a public Slack channel. | ||
| 1. Candidates must demonstrate strong, ongoing commitment to the project by actively contributing, reviewing pull requests, and managing issues for at least three months. | ||
| 2. Current maintainers review and propose new maintainers through a pull request. | ||
| 3. A candidate requires at least 66% approval from existing maintainers to be added. Only one maintainer per organization is allowed. | ||
|
|
||
| ## Stepping down policy | ||
| For the reviewer role, candidates need 33% approval from current maintainers. | ||
|
|
||
| Life priorities, interests, and passions can change. If you're a maintainer but | ||
| feel you must remove yourself from the list, inform other maintainers that you | ||
| intend to step down, and if possible, help find someone to pick up your work. | ||
| At the very least, ensure your work can be continued where you left off. | ||
| ## Adding Emeritus Maintainers | ||
|
|
||
| After you've informed other maintainers, create a pull request to remove | ||
| yourself from the MAINTAINERS file. | ||
| To transition a maintainer to emeritus status: | ||
|
|
||
| ## Removal of inactive maintainers | ||
| 1. Follow the same voting and approval process as for adding new maintainers. | ||
| 2. A pull request is created for the transition, requiring a 66% approval vote from current maintainers. | ||
| 3. Once approved, the emeritus maintainer is added to the EMERITUS file and announced to the community. | ||
|
|
||
| ## Subprojects | ||
|
|
||
| Similar to the procedure for adding new maintainers, existing maintainers can | ||
| be removed from the list if they do not show significant activity on the | ||
| project. Periodically, the maintainers review the list of maintainers and their | ||
| activity over the last three months. | ||
| ### Adding Core Subprojects | ||
|
|
||
| If a maintainer has shown insufficient activity over this period, a neutral | ||
| person will contact the maintainer to ask if they want to continue being | ||
| a maintainer. If the maintainer decides to step down as a maintainer, they | ||
| open a pull request to be removed from the MAINTAINERS file. | ||
| 1. To add a new subproject, submit a GitHub issue in the specification repository. | ||
| 2. Existing maintainers have fourteen business days to discuss and vote on the proposal. | ||
| 3. A subproject requires at least 66% approval from current maintainers. | ||
|
|
||
| If the maintainer wants to remain a maintainer, but is unable to perform the | ||
| required duties they can be removed with a vote of at least 66% of | ||
| the current maintainers. An e-mail is sent to the | ||
| mailing list, inviting maintainers of the project to vote. The voting period is | ||
| fourteen business days. Issues related to a maintainers performance should be | ||
| discussed with them among the other maintainers so that they are not surprised | ||
| by a pull request removing them. | ||
| ### Stepping Down | ||
|
|
||
| ## How are decisions made? | ||
| Maintainers intending to step down should: | ||
|
|
||
| Synapse is an open-source project with an open design philosophy. This means | ||
| that the repository is the source of truth for EVERY aspect of the project, | ||
| including its philosophy, design, road map, and APIs. *If it's part of the | ||
| project, it's in the repository. If it's in the repository, it's part of the project.* | ||
| 1. Inform other maintainers and, if possible, help find a successor. | ||
| 2. Open a pull request to remove their name from the MAINTAINERS file. | ||
|
|
||
| As a result, all decisions can be expressed as changes to the repository. An | ||
| implementation change is a change to the source code. An API change is a change | ||
| to the API specification, and so on. | ||
| ## Removal of Inactive Maintainers | ||
|
|
||
| All decisions affecting Synapse, big and small, follow the same 3 steps: | ||
| Inactive maintainers are reviewed periodically. If a maintainer has not been active for three months: | ||
|
|
||
| * Step 1: Open a pull request. Anyone can do this. | ||
| 1. A neutral person will contact them to confirm their desire to continue. | ||
| 2. If they wish to step down, a pull request is opened to remove them from the MAINTAINERS file. | ||
| 3. If they wish to remain but cannot perform their duties, they can be removed with a 66% vote from the current maintainers. | ||
|
|
||
| * Step 2: Discuss the pull request. Anyone can do this. | ||
| ## Decision-Making Process | ||
|
|
||
| * Step 3: Merge or refuse the pull request. Who does this depends on the nature | ||
| of the pull request and which areas of the project it affects. | ||
| Decisions are made through: | ||
|
|
||
| ## I'm a maintainer. Should I make pull requests too? | ||
| 1. Opening a pull request, which anyone can do. | ||
| 2. Discussing the pull request, which anyone can contribute to. | ||
| 3. Merging or refusing the pull request, which depends on the nature of the change. | ||
|
|
||
| Yes. Nobody should ever push to master directly. All changes should be | ||
| made through a pull request. | ||
| Consensus among maintainers is required for significant decisions. Proposals should be discussed before opening a pull request. | ||
|
|
||
| ## Maintainer Pull Requests | ||
|
|
||
| Maintainers must also make changes via pull requests. Direct pushes to master are not allowed. For details, see the [Contributing](contributing.md) guide. | ||
|
|
||
| ## Conflict Resolution | ||
|
|
||
| If you have a technical dispute that you feel has reached an impasse with a | ||
| subset of the community, any contributor may open an issue, specifically | ||
| calling for a resolution vote of the current core maintainers to resolve the dispute. | ||
| The same voting quorums required (2/3) for adding and removing maintainers | ||
| will apply to conflict resolution. | ||
| To merge changes, at least one maintainer must approve the pull request. If maintainers do not voice their opinions within two days, their approval is assumed via [lazy consensus](http://communitymgt.wikia.com/wiki/Lazy_consensus). | ||
|
|
||
| For disputes, efforts should be made to resolve issues amicably. If unresolved, a third-party maintainer can mediate. The core maintainers have the final say, making decisions by consensus or majority vote if necessary, ideally within two weeks. | ||
|
|
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,4 +1,4 @@ | ||
| # Synapse Maintainers | ||
| # Maintainers | ||
|
|
||
| * [Charles d'Avernas](https://github.com/cdavernas) | ||
| * [Jean-Baptiste Bianchi](https://github.com/jbbianchi) |
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
Oops, something went wrong.