AsyncAPI Community

Welcome to the AsyncAPI Initiative! Our mission is to improve the current state of Event-Driven Architectures (EDAs) and the tooling ecosystem around them. Join us in shaping the future of how you work with Event-Driven Architectures.

Community Goals 🎯

We set annual community goals that guide our growth and initiatives every year. Join us as we enhance maintainers' support, simplify onboarding, and establish structured community initiatives and programs.

More details »

Community Documentation & Onboarding

Find all the resources you need to start contributing to our organization.

Getting Started

1. Follow the Code of Conduct and help keep the community inclusive and respectful.

2. Read the Contribution Guide and learn how to contribute effectively.

3. Explore the Contributing Guide, a guide on where and how to contribute for new contributors.

4. Follow the AsyncAPI Style Guide to ensure consistency across all docs.

Community Governance and Charter

Our community is steered by a transparent governance board. You can learn more about our Community Governance and the AsyncAPI Charter, which outlines the decision-making process, structure, responsibilities, and procedures for contributions and oversight of the AsyncAPI open project.

AsyncAPI Technical Steering Committee (TSC)

The TSC is a group of maintainers and Ambassadors responsible for the maintenance and decision-making of the AsyncAPI Initiative. It was formed to ensure open governance and neutrality.

Want To Become a TSC Member?

• Read the requirements and responsibilities on becoming a TSC Member or watch our YouTube video on how to become a TSC member.
• Or explore if you meet the requirements of becoming an AsyncAPI Ambassador.

Need Help? 🤝

If you have any questions or need guidance, please reach out through our GitHub Discussions page or via Slack.

Join our Community Calls

We invite you to join our Events & Meetings, and we hope to see you at one of the AsyncAPI Conferences.

---

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Development

The AsyncAPI Community repository includes extensive automation powered by custom scripts. To ensure these scripts function correctly, proper testing is essential. This section explains how to run existing tests and how to add new ones.

Running Tests

We use Jest for testing automation scripts. To run the tests locally, follow these steps:

1. Install dependencies:

   npm install
   

2. Run all tests:

   npm test
   

Adding New Tests

If you are contributing new automation scripts, ensure they are covered by tests. To add a new test:

1. Create or update the relevant test file in the test/ directory.
2. Follow the existing Jest structure for consistency.
3. Ensure your test covers edge cases and different scenarios.
4. Run the tests locally before pushing your changes.

All contributions to automation should include proper test coverage to maintain reliability.