Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Examples:
- Our sincere gratitude and respect for your contributions!

### Additional resources
[AsyncAPI Ambassador Program](../020-governance-and-policies/ambassador-program/AMBASSADOR_PROGRAM.md)
[AsyncAPI Ambassador Program](../020-governance-and-policies/AMBASSADOR_PROGRAM)
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ As an open-source initiative with a global community, technical writer contribut
Complete in order the following onboarding tasks:

- [ ] Read the [AsyncAPI Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
- [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette.md).
- [ ] Read the [AsyncAPI Slack etiquette](../060-meetings-and-communication/slack-etiquette).
- [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
- [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities.md).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge.md).
- [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
- [ ] Familiarize yourself with the [AsyncAPI Style Guide](../011-styleguide).
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow.md).
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](../010-contribution-guidelines/git-workflow).
- [ ] Introduce yourself in AsyncAPI Slack in the `#01_introductions` channel and the `#13_docs` channel. Ask docs-related questions in #13_docs.
- [ ] Request a good first docs issue in the [`#13_docs` Slack channel](https://asyncapi.com/slack-invite).
- [ ] Attend [OPEN docs meetings](https://www.asyncapi.com/community/events) to chat with other maintainers, ask docs questions, and request help on docs blockers.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**.

### 2. Open a PR

For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../010-contribution-guidelines/git-workflow.md).
For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](../010-contribution-guidelines/git-workflow).

- **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you experience or observe discrimination, harassment, or any behavior that vi
### 2. Report the Incident
You can report a CoC violation by:

- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](../CODE_OF_CONDUCT_COMMITTEE.md)
- Emailing **conduct@asyncapi.io** – this forwards directly to the [Code of Conduct Committee](../CODE_OF_CONDUCT_COMMITTEE)
- Reaching out to a specific CoC Committee member if the issue involves someone on the committee

All reports are handled with confidentiality, respect, and prompt action.
Expand All @@ -61,5 +61,5 @@ The Code of Conduct Committee is trained to resolve conflicts fairly and ensure


## Additional Resources
- [Incident Resolution Procedures](../COC-incident-resolution-procedures.md)
- [Slack Etiquette Guidelines](../060-meetings-and-communication/slack-etiquette.md)
- [Incident Resolution Procedures](../COC-incident-resolution-procedures)
- [Slack Etiquette Guidelines](../060-meetings-and-communication/slack-etiquette)
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Here's how to select an issue to contribute to:

**Step 2: Open a Pull Request**

To open a pull request successfully, follow our [Git workflows contributors guide](git-workflow.md).
To open a pull request successfully, follow our [Git workflows contributors guide](git-workflow).

Use the following steps to open your pull request:
1. Configure a fork
2. Work on it locally
3. Write an appropriate PR title using the [conventional commits specification](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits)
3. Write an appropriate PR title using the [conventional commits specification](../010-contribution-guidelines/conventional-commits)
4. Test your PR against GitHub checks to ensure they all pass

**Step 3: Get Pull Request Merged**
Expand All @@ -45,4 +45,4 @@ After making several contributions to AsyncAPI, maintainers will recognize you.

Once you become a maintainer in one of the repositories, you can apply to join a group of [TSC members](https://www.asyncapi.com/community/tsc).

Open a PR in the **community** repository to add your name to the [list of TSC members](../../TSC_BOARD_MEMBERS.yaml). Specify your name, repositories that you maintain, and if you are sponsored by some company. For example [see this PR that introduced one of the new TSC members](https://github.com/asyncapi/community/pull/277).
Open a PR in the **community** repository to add your name to the [list of TSC members](https://github.com/asyncapi/community/blob/master/TSC_BOARD_MEMBERS.yaml). Specify your name, repositories that you maintain, and if you are sponsored by some company. For example [see this PR that introduced one of the new TSC members](https://github.com/asyncapi/community/pull/277).
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@ Welcome to the AsyncAPI community! We're excited to have you here. Think of Asyn
## Prerequisites
Before you begin contributing code, make sure you're familiar with the following:

- [Git Workflow Guide](git-workflow.md): Learn how to fork, branch, commit, and open pull requests.
- [Git Workflow Guide](git-workflow): Learn how to fork, branch, commit, and open pull requests.
- [Git](https://git-scm.com) and [GitHub](https://github.com): These are your primary tools for version control and collaboration. Learn the basics [here](https://docs.github.com/en/get-started).
- Code Editor: Your tool to work with the source code of our repositories and version control. For example, [VS Code](https://code.visualstudio.com), [Sublime Text](https://www.sublimetext.com), [JetBrains IDEs](https://www.jetbrains.com/ides/), or any other tool you prefer.
- [Node.js & npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm): AsyncAPI relies on JavaScript/TypeScript, so ensure these are installed and configured.

## Contribution Etiquette
1. Follow the [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md)
2. Stick to the [Contributing guidelines](../../CONTRIBUTING.md)
2. Stick to the [Contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md)
3. Document the "why" of your contribution(s). Make sure that someone who opens the code for the first time understands the changes you've made.
4. Communicate openly through discussions on GitHub or designated Slack channels.

## Submit Your First Pull Request (PR)

Once you've made and committed your changes (following the Git Workflow guide), you need to create a Pull Request (PR) to propose merging your work into the official AsyncAPI repository. Make sure to use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) while creating PRs and follow these steps:
Once you've made and committed your changes (following the Git Workflow guide), you need to create a Pull Request (PR) to propose merging your work into the official AsyncAPI repository. Make sure to use the [conventional commit style](../010-contribution-guidelines/conventional-commits) while creating PRs and follow these steps:

### Create a Pull Request (PR)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ At AsyncAPI, we value **quality over quantity**. This guide will help you make m
- Read the [documentation](https://www.asyncapi.com/docs) to learn more about AsyncAPI.

### Before Making a Contribution
- Read the [onboarding contributor guide](https://www.asyncapi.com/docs/community/onboarding-guide).
- If you are contributing to the community repository, review the [documentation onboarding checklist](https://www.asyncapi.com/docs/community/onboarding-guide/docs-onboarding-checklist).
- For other repositories, refer to the [general contribution guidelines](../../CONTRIBUTING.md).
- Read the [onboarding contributor guide](../000-onboarding).
- If you are contributing to the community repository, review the [documentation onboarding checklist](../000-onboarding/docs-onboarding-checklist).
- For other repositories, refer to the [general contribution guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
- Look through existing issues and pull requests to understand the repository better.
- Check the [general roadmap](https://www.asyncapi.com/roadmap).

### Steps to making a good contribution
1. Set up your workflow environment using the [git workflow guide](git-workflow.md).
1. Set up your workflow environment using the [git workflow guide](git-workflow).
2. Search for [good first issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22).
3. When you find one, comment on your interest and share the approach to solving the issue (please don't ask to be assigned, as it could be flagged as spam).
4. If you noticed a bug, typo, or needed improvement, feel free to create an issue.
5. **Make a PR only after a maintainer assigned the issue to you or asks you to work on it** even if you created the issue yourself.
6. Follow the [conventional commits guide](conventional-commits.md) to write a good PR title.
7. Follow the [git workflow document](git-workflow.md) when working on your changes and making a PR.
6. Follow the [conventional commits guide](conventional-commits) to write a good PR title.
7. Follow the [git workflow document](git-workflow) when working on your changes and making a PR.
8. After making a PR, patiently wait for reviews.
9. Make sure all your PR checks pass (turn green) to speed up the merging process.
10. If your PR hasn’t been reviewed after **a week and a half**, you can gently remind a maintainer on Slack or GitHub. Delays can happen for various reasons, but no one is ignoring you! 🙏🏼 .
Expand All @@ -46,7 +46,7 @@ These rules are here to help you succeed and to support the maintainers and comm
- **Be patient**. Maintainers are volunteers with their jobs, families, and responsibilities. It may take time for your PR or issue to be reviewed.
- **Use the right Slack channels**. If you're unsure where to post, ask politely or take a moment to check.
- **Keep Slack tidy**. Use threads for conversations, avoid tagging `@maintainers` unless truly necessary, and don’t spam.
- Follow our [Slack etiquette](../060-meetings-and-communication/slack-etiquette.md) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
- Follow our [Slack etiquette](../060-meetings-and-communication/slack-etiquette) and [Code of Conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
- **Respect others**. Treat everyone with kindness and patience. We are all here to learn and grow together.

### ❌ What You Should Never Do
Expand All @@ -73,7 +73,7 @@ Before submitting your contribution, ask yourself:
- [ ] Is my contribution relevant to AsyncAPI?
- [ ] Have I explained why this contribution is necessary?
- [ ] Is my writing clear, concise, and well-structured?
- [ ] Did I follow the [documentation style guide](https://github.com/asyncapi/community/tree/master/docs/styleguide)?
- [ ] Did I follow the [documentation style guide](../011-styleguide)?
- [ ] Have my code examples been tested, and are they functional?
- [ ] Have I linked any relevant issues, discussions, or existing docs?
- [ ] Did I provide a description of the changes in my PR?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ You can follow the steps from the [GitHub documentation](https://docs.github.com
## Start Contributing

1. Create a branch on your fork.
2. Commit changes with clear messages. Use the [Conventional Commits](https://github.com/asyncapi/community/pull/1733) format.
2. Commit changes with clear messages. Use the [Conventional Commits](../010-contribution-guidelines/conventional-commits) format.
3. Push changes to your fork:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ AsyncAPI follows a "first come, first served" approach for assigning issues. Her
- **Comment on the issue:** Start with saying something like, "Hey, I'd like to work on this!" so maintainers know you're interested.

- **Once you comment, wait for approval by maintainers:** They may guide you further (if needed) or might assign the issue to you. If there are no blockers, you can start working!
- **Start coding**: Once approved, head on to the [git workflow guide](git-workflow.md), and start working!
- **Start coding**: Once approved, head on to the [git workflow guide](git-workflow), and start working!
- **Ask for help**: Don't hesitate to ask in the issue comments or the dedicated AsyncAPI Slack Channel if you're stuck.

So what are you waiting for? Go find your first quest, and let's build something awesome together!
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Create and submit a docs pull request (PR) via the following steps:

- A Docs’ PR should solve one documentation problem.
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR.
- Use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
- Use the [conventional commit style](../010-contribution-guidelines/conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
- Please check your contribution and ensure it follows the AsyncAPI style guide.
- Tag other technical writers to review your document.
- Tag an engineer or subject matter expert (SME) to review the technical details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ These are the recommended tools for contributors, as well as instructions for se
2. Open Command Prompt on your local computer.

3. Clone the forked repository by adding your GitHub username instead of `<username>`.
For multiple contributions, follow the [proper configuration of a forked AsyncAPI repo](git-workflow.md).
For multiple contributions, follow the [proper configuration of a forked AsyncAPI repo](git-workflow).

```bash
git clone https://github.com/<username>/website/
Expand Down
2 changes: 1 addition & 1 deletion markdown/docs/community/011-styleguide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ The AsyncAPI style guide helps community members learn how to contribute to our

The goal is to provide docs contributors with the same guidelines to make it easier for readers to find the necessary information.

> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md).
> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions markdown/docs/community/011-styleguide/styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ Use asterisks for italics (`*italic*`) and bold (`**bold**`). You can also use u
### Links
Use square brackets to describe links and a parenthesis to insert the actual links. Always use descriptive link text. Avoid phrases like "click here."

- **✅ Good:** See our [Contribution Guide](/docs/community/contribution-guide) for more.
- **✅ Good:** See our [Contribution Guide](../010-contribution-guidelines) for more.

- **❌ Bad:** For more info, [click here](https://.../contribution-guide).
- **❌ Bad:** For more info, [click here](../010-contribution-guidelines).

### Code Blocks
Use backticks for inline code (`const foo = 'bar';`). For code blocks, use triple backticks and specify the language for syntax highlighting.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ When contributing to documentation, keep the following in mind:

### Need Help?

Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow.md).
Need more assistance with contributing to documentation, check out the [AsyncAPI contribution flow guidelines](../010-contribution-guidelines/contribution-flow).
Loading
Loading