-
-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: update of files from global .github repo (#979)
- Loading branch information
1 parent
8b64b11
commit 96c2255
Showing
6 changed files
with
71 additions
and
28 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
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 |
|---|---|---|
|
|
@@ -82,4 +82,4 @@ jobs: | |
| body: message, | ||
| event: 'COMMENT' | ||
| }); | ||
| } | ||
| } | ||
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,36 +1,79 @@ | ||
| # Contributing | ||
| # Contributing to AsyncAPI | ||
| We love your input! We want to make contributing to this project as easy and transparent as possible. | ||
|
|
||
| ## Overview | ||
| ## Contribution recogniton | ||
|
|
||
| Learn the rules to follow when you contribute code or content to this project. | ||
| We use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions. For more details read [this](https://github.com/asyncapi/community/blob/master/recognize-contributors.md) document. | ||
|
|
||
| ## Contributing process | ||
| ## Summary of the contribution flow | ||
|
|
||
| The contributing process in this project relies on the [GitHub flow](https://guides.github.com/introduction/flow/index.html). This means that you contribute through pull requests (PRs). When adding new code or content to this project, follow these rules: | ||
| The following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate. | ||
|
|
||
| 1. Fork this repository. | ||
| 1. Make your changes. Do not forgot about: | ||
| - [Naming and architecture convention](./docs/development/guide.md#naming-and-architecture-convention) | ||
| - [Project structure](./docs/development/guide.md#project-structure) | ||
| - Tests | ||
| - Updating relevant documents if you add, remove, update props or configuration. | ||
| 1. Create a PR. | ||
| ``` | ||
| ┌───────────────────────┐ | ||
| │ │ | ||
| │ Open an issue │ | ||
| │ (a bug report or a │ | ||
| │ feature request) │ | ||
| │ │ | ||
| └───────────────────────┘ | ||
| ⇩ | ||
| ┌───────────────────────┐ | ||
| │ │ | ||
| │ Open a Pull Request │ | ||
| │ (only after issue │ | ||
| │ is approved) │ | ||
| │ │ | ||
| └───────────────────────┘ | ||
| ⇩ | ||
| ┌───────────────────────┐ | ||
| │ │ | ||
| │ Your changes will │ | ||
| │ be merged and │ | ||
| │ published on the next │ | ||
| │ release │ | ||
| │ │ | ||
| └───────────────────────┘ | ||
| ``` | ||
|
|
||
| PRs are very welcome. However, if you want to add a new feature, use GitHub issues to discuss your ideas first. | ||
| ## Code of Conduct | ||
| AsyncAPI has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](./CODE_OF_CONDUCT.md) so that you can understand what sort of behaviour is expected. | ||
|
|
||
| ## Our Development Process | ||
| We use Github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
|
||
| ## Issues | ||
| [Open an issue](https://github.com/asyncapi/asyncapi/issues/new) **only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Slack workspace](https://www.asyncapi.com/slack-invite) and ask there. Don't forget to follow our [Slack Etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) while interacting with community members! It's more likely you'll get help, and much faster! | ||
|
|
||
| ## Bug Reports and Feature Requests | ||
|
|
||
| Please use our issues templates that provide you with hints on what information we need from you to help you out. | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| **Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification. Get familiar with our document that explains [Git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md) used in our repositories. | ||
|
|
||
| ## Conventional commits | ||
|
|
||
| This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/). | ||
| Our repositories follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/). | ||
|
|
||
| Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want: | ||
|
|
||
| - `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered. | ||
| - `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered. | ||
| - `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release. | ||
| - `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release. | ||
| - `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release. | ||
| - `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release. | ||
|
|
||
| What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: ` | ||
|
|
||
| A PR should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification, simply ask maintainers to modify the PR. You can also use this cheatsheet: | ||
| Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative). | ||
|
|
||
| - `fix: ` prefix in the title indicates that a PR is a bug fix and the PATCH release must be triggered. | ||
| - `feat: ` prefix in the title indicates that a PR is a feature and the MINOR release must be triggered. | ||
| - `docs: ` prefix in the title indicates that a PR is only related to the documentation and there is no need to trigger a release. | ||
| - `chore: ` prefix in the title indicates that a PR is only related to the project cleanup and there is no need to trigger a release. | ||
| - `test: ` prefix in the title indicates that a PR is only related to tests and there is no need to trigger a release. | ||
| - `refactor: ` prefix in the title indicates that a PR is only related to refactoring and there is no need to trigger a release. | ||
| Happy contributing :heart: | ||
|
|
||
| For a MAJOR release, just add `!` to the prefix, like `fix!: ` or `refactor!: `. | ||
| ## License | ||
| When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/asyncapi/asyncapi/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://www.asyncapi.com/slack-invite) if that's a concern. | ||
|
|
||
| A prefix that follows the specification is not enough though. Remember that the title must be clear, descriptive, and in the [imperative mood](https://chris.beams.io/posts/git-commit/#imperative). | ||
| ## References | ||
| This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md). |