Skip to content

docs: add onboarding code contributor guide #1725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
7185f88
Create code-contributor-guide.md
SaxenaAnushka102 Feb 16, 2025
0a4a9e6
Update docs/onboarding-guide/code-contributor-guide.md
SaxenaAnushka102 Feb 22, 2025
26375e4
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack Feb 26, 2025
0c0d51d
Add suggested changes
SaxenaAnushka102 Mar 15, 2025
7616dcd
Merge branch 'asyncapi:master' into onboarding-code-contributor-guide
SaxenaAnushka102 Mar 16, 2025
ba3a5bd
fix: add frontmatter to the onboarding guide docs
SaxenaAnushka102 Mar 16, 2025
16ae279
Merge branch 'asyncapi:master' into onboarding-code-contributor-guide
SaxenaAnushka102 Mar 19, 2025
4719f0a
Remove Contribution Strategy section
SaxenaAnushka102 Mar 19, 2025
efea981
Merge branch 'asyncapi:master' into onboarding-code-contributor-guide
SaxenaAnushka102 Mar 23, 2025
4f705fd
Merge branch 'master' into onboarding-code-contributor-guide
SaxenaAnushka102 Mar 30, 2025
de1fa32
remove bold headings
SaxenaAnushka102 Mar 30, 2025
11b9727
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack Apr 2, 2025
6123f3c
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack Apr 8, 2025
7f63267
add description to code contributor guide page
SaxenaAnushka102 Apr 18, 2025
8a16aea
Merge branch 'master' into onboarding-code-contributor-guide
asyncapi-bot Apr 18, 2025
b9dd9be
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack Apr 23, 2025
67c3123
edit commit format in code contributor guide
SaxenaAnushka102 Apr 26, 2025
0c280ee
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack Apr 29, 2025
b3d4cfa
remove make code changes section
SaxenaAnushka102 Apr 30, 2025
d826ad1
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack May 6, 2025
81eadd9
Merge branch 'master' into onboarding-code-contributor-guide
thulieblack May 8, 2025
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
47 changes: 47 additions & 0 deletions docs/onboarding-guide/code-contributor-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: AsyncAPI Code Contributor Guide
description: A guide for new contributors looking to contribute code to the AsyncAPI project.
weight: 90
---
# AsyncAPI Code Contributor Guide

Welcome to the AsyncAPI community! We're excited to have you here. Think of AsyncAPI as a collaborative puzzle - your contributions are essential to completing it. This guide will help you get started smoothly.

## Understanding AsyncAPI
[AsyncAPI](https://www.asyncapi.com/en) is an open-source initiative for defining and building event-driven architectures. Our repositories house tools, specifications, and generators that make event-driven systems easier to work with. Each repo has a purpose, detailed in its `README.md`.

## Prerequisites
Before you begin contributing code, make sure you're familiar with the following:

- [Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md): 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.

Comment on lines +13 to +20
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🛠️ Refactor suggestion

🧩 Analysis chain

Avoid duplicating “Recommended Tools” content
You list code editors and Node.js/npm here, but we already maintain a central “Recommended Tools” document. Consider linking to that instead to keep a single source of truth and reduce future maintenance.

Would you like assistance drafting that link update?


🏁 Script executed:

#!/bin/bash
# Search for any occurrence of "Recommended Tools" in the docs directory
rg -i -n "Recommended Tools" docs

# List any markdown files with "tools" in their filename
fd '*tools*.md'

Length of output: 665


Consolidate “Recommended Tools” content
The contributor guide is duplicating the editor and Node.js/npm recommendations already maintained in docs/onboarding-guide/tools-and-setup.md. To keep one source of truth, please:

  • In docs/onboarding-guide/code-contributor-guide.md (lines 13–20), remove the explicit editor/Node.js bullets.
  • Add a single link, for example:
    See our [Recommended Tools and Setup](../tools-and-setup.md) for editors, Node.js/npm, and other dependencies.

Let me know if you’d like a ready-made diff for this update.

## Contribution Etiquette
1. Follow the [Code of Conduct](https://github.com/asyncapi/community/blob/master/CODE_OF_CONDUCT.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:

### Create a Pull Request (PR)

Now, go to your forked repository on GitHub (ex.- `https://github.com/your-username/generator`):

1. You’ll see a notification about your recently pushed branch. Click the "Compare & pull request" button.
2. Make sure the base repository is `asyncapi/generator` (upstream) and the head repository is your fork (`your-username/generator`).
3. Add a clear title and description explaining your changes.
4. Click "Create pull request" to submit your PR for review.

That's it! You've successfully submitted your first Pull Request.

### Wait for Review & Merge
- The maintainers will review your PR.
- If needed, respond to their comments and make changes.
- Once approved, a maintainer will merge your PR into the official AsyncAPI repository!

Every contribution matters, no matter how small. Dive in and let’s build something amazing together!