diff --git a/.changeset/1802.md b/.changeset/1802.md new file mode 100644 index 00000000000..a2cdc401d93 --- /dev/null +++ b/.changeset/1802.md @@ -0,0 +1,9 @@ +--- +'@asyncapi/cli': minor +--- + +feat: update contributing guidelines + +- 95582d7: feat: update contributing guidelines + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1334921c281..ddd80e35eaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,4 +76,30 @@ Happy contributing :heart: 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. ## 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). \ No newline at end of file +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md). + + +## Maintainers + +Maintainers are responsible for overseeing the project’s overall health and progress. Their duties include managing and assigning issues, reviewing pull requests, and ensuring consistent development. + +The project is organized into distinct scopes, whith each maintainer assigned to one or more scopes they are resposible for managing and overseeing. + +During triaging, maintainers are responsible for assigning scope labels to issues, ensuring they are directed to the appropriate maintainer for further investigation and action. + +Maintainers are encouraged to hold weekly or bi-weekly meetings to engage with contributors and the community, providing updates on ongoing work and fostering collaboration around open issues. + +As of now we are diving the project scope to: + +- core +- commands +- docs +- server-api +- GitHub Actions +- ci/cd + + +## Contributors + +If a contributor is assigned to an issue but doesn't start work or provide any updates within a week, they may be unassigned so the issue can be made available to others. While we don't expect contributors to complete the work within a week, claiming an issue and then going inactive without communication can hinder project progress. +