|
6 | 6 |
|
7 | 7 | Welcome to the AsyncAPI Community! 🚀 We believe in the power of open-source collaboration and appreciate your interest in contributing. Whether you're improving the documentation, fixing bugs, or adding new features, your contributions help make AsyncAPI better for everyone. 💙
|
8 | 8 |
|
| 9 | +--- |
| 10 | +### Our Mission |
| 11 | +AsyncAPI is dedicated to creating open-source, vendor-neutral specifications and tools that help develop and govern APIs. Our community thrives on collaboration and a shared vision of making API development more accessible, efficient, and innovative. We embrace diversity, ensuring that every voice is heard and every contribution matters. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +### Community Governance & Leadership |
| 16 | +Our community is steered by a transparent governance model designed to empower collaboration. |
| 17 | +Learn about our transparent governance and decision-making process [here](https://github.com/asyncapi/community/blob/master/GOVERNANCE.md). |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +### Our Charter |
| 22 | +Our [Charter](https://github.com/asyncapi/community/blob/master/CHARTER.md) sets the foundation for our technical contributions and community collaboration. It outlines: |
| 23 | + |
| 24 | + - Mission and Scope: Our commitment to creating open, vendor-neutral API tools and specifications. |
| 25 | + - Technical Steering Committee (TSC): Guidelines on the TSC's composition, decision-making, and participation expectations. |
| 26 | + - Contributor and Committer Guidelines: How we manage contributions, intellectual property, and compliance with our policies. |
| 27 | + |
| 28 | +--- |
| 29 | + |
9 | 30 | ### 🔖 Code of Conduct
|
10 |
| -Before you begin, please **go through our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md)** to ensure a respectful and welcoming community. Find more about contributing to our Docs at **[AsyncAPI Docs Communtiy](https://www.asyncapi.com/docs/community)**. |
| 31 | +Read our [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md) to understand our community values and expected behavior. |
11 | 32 |
|
12 | 33 | ---
|
13 | 34 |
|
| 35 | +### Technical Steering Committee (TSC) |
| 36 | +Meet our [TSC](https://www.asyncapi.com/community/tsc), the group of core maintainers responsible for high-level decisions and project direction. |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +### Ambassador Program |
| 41 | +Learn how our **AsyncAPI Ambassador Program** brings AsyncAPI closer to users by empowering community members—whether you contribute code, write blog posts, or speak at events—to help spread knowledge and foster growth. |
| 42 | + |
| 43 | +[More details »](https://github.com/asyncapi/community/blob/master/AMBASSADOR_ORGANIZATION.md) |
| 44 | + |
14 | 45 | ## 🛠 How to Contribute to Our docs
|
15 | 46 |
|
16 | 47 | We believe that **code is cool**, but **great docs make all the difference**!
|
17 | 48 |
|
18 |
| -- Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md). |
19 |
| -- Go through the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md). |
20 |
| -- Join our [AsyncAPI Docs Community](https://www.asyncapi.com/docs/community). |
21 |
| -- Add the AsyncAPI calendar from the [AsyncAPI events](https://www.asyncapi.com/community/events) page to stay updated on meetings and events. |
| 49 | + Find more about contributing to our Docs at **[AsyncAPI Docs](https://www.asyncapi.com/docs/community)**. |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +### Become a Maintainer |
| 54 | +Not sure how to make your first contribution? Follow our to be a part of [TSC](https://github.com/asyncapi/community/blob/master/TSC_MEMBERSHIP.md). |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +### Contribution Guidelines |
| 59 | + |
| 60 | +We want your input! Our [Contribution Guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) provide a clear roadmap for submitting pull requests, engaging with reviews, and ensuring your contributions meet community standards. |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +### Working Groups |
| 65 | + |
| 66 | +Working Groups are sub-communities formed around common interests. Each group (with at least 3 founding members) has a chairperson elected by its members, and their details are maintained in the [WORKING_GROUPS](https://github.com/asyncapi/community/blob/master/WORKING_GROUPS.md). They collaborate openly, using tools like GitHub Projects and our Slack channels. |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +### Technical Writer Onboarding |
22 | 71 | - Review the list of [technical writer contributor](https://www.asyncapi.com/docs/community/onboarding-guide/technical-writer-contributor-responsibilities) responsibilities to understand your role.
|
23 |
| -- Familiarize yourself with [prerequisite knowledge topics](https://www.asyncapi.com/docs/community/onboarding-guide/prerequisite-knowledge) required for contributing. |
24 |
| -- Check out the work-in-progress [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide) to ensure consistency in documentation. |
25 |
| -- Read all documentation under the following content buckets: |
26 |
| - - Concepts |
27 |
| - - Tutorials (take time to go through each tutorial) |
28 |
| - - Reference |
29 |
| -- Set up your local environment following the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md). |
30 |
| -- Introduce yourself in AsyncAPI Slack in the **#01_introductions channel** and the #13_docs channel. Ask docs-related questions in #13_docs. |
31 |
| -- Request a good first docs issue in the **#13_docs** [Slack channel](https://asyncapi.slack.com/ssb/redirect). |
32 |
| -- Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers. |
33 |
| - |
34 |
| - |
35 |
| -## 🛠 Contribution Flow |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +### Slack Etiquette |
| 76 | + |
| 77 | +Our Slack workspace is vital for real-time conversations. Please refer to our [Slack Etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) guidelines to ensure respectful, productive, and spam-free interactions. |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +### 🛠 Contribution Flow |
36 | 82 |
|
37 | 83 | Go through our **[Contribution Flow](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md#contribution-flow)** document to better understand.
|
38 | 84 |
|
|
0 commit comments