docs: add onboarding code contributor guide #1725
Conversation
SaxenaAnushka102
requested review from
quetzalliwrites,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
|
|
||
| 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. | ||
|
|
||
| --- |
There was a problem hiding this comment.
I would rather remove these lines everywhere, as they are not consistent (there is no line before the last h2 heading) and also add visual noise
| --- |
|
|
||
| ## Tools You’ll Need | ||
| - **Git and GitHub**: Your tools for collaboration. Get familiar with forking, branching, and pull requests. | ||
| - **Code Editor**: Your favourite IDEs like VS Code. |
There was a problem hiding this comment.
Technically speaking, VS Code is not an IDE, it's a code editor
| - **Code Editor**: Your favourite IDEs like VS Code. | |
| - **Code Editor**: Your tool to work with the source code of our repositories and version control. For example, VS Code, Sublime Text, JetBrains IDEs, or any other tool you prefer. |
| ## Tools You’ll Need | ||
| - **Git and GitHub**: Your tools for collaboration. Get familiar with forking, branching, and pull requests. | ||
| - **Code Editor**: Your favourite IDEs like VS Code. | ||
| - **Node.js & NPM**: AsyncAPI relies on JavaScript, so ensure these are installed and configured. |
There was a problem hiding this comment.
| - **Node.js & NPM**: AsyncAPI relies on JavaScript, so ensure these are installed and configured. | |
| - **Node.js and npm**: AsyncAPI relies on JavaScript/TypeScript, so ensure these are installed and configured. |
|
|
||
| ## Starting Small | ||
| - Look for `good first issue` or `help wanted` labels in the repository. These are beginner-friendly issues to get you started. | ||
| - Join our [Slack workspace](https://t.co/YbJQ4ghX7Q) for help and to connect with the community. |
There was a problem hiding this comment.
@thulieblack just a thought: I remember one of our Mentorship meetings, where you said that dedicated Slack channels act as your target audience, mentors, tutors, so you should use them to get as much feedback as possible and don't be afraid to ask questions, as someone said "The only stupid question is the one that is not asked".
I think it's worth adding this info to slack-etiquette because I bet that "what and how to ask in channels" is a common stumbling stone for newcomers.
| - Your **fork** is the `origin`. | ||
| - The official AsyncAPI repository is the `upstream`. |
| # git@github.com:asyncapi/generator.git | ||
|
|
||
| git remote add upstream <upstream git repo> | ||
| git remote set-url --push upstream no_push |
There was a problem hiding this comment.
Are you sure that this step is required? If I'm not mistaken, regular contributors will receive the standard Permission denied error when trying to push to upstream directly.
| ### Verify with: | ||
| ```bash | ||
| git remote -v | ||
| ``` |
There was a problem hiding this comment.
You showed an example above, so I think it would be useful for newcomers to see example output of this command as well. Or even better, show output of git remote -v before adding upstream, and after.
Verify that upstream has been set:
git remote -vExample output:
origin https://github.com/<username>/generator.git (fetch)
origin https://github.com/<username>/generator.git (push)
upstream git@github.com:asyncapi/generator.git (fetch)
upstream git@github.com:asyncapi/generator.git (push)| ``` | ||
|
|
||
| ### Keeping Your Fork in Sync | ||
| Before starting new work, sync your fork with the upstream: |
There was a problem hiding this comment.
| Before starting new work, sync your fork with the upstream: | |
| Before starting new work, sync your `origin` with the `upstream`: |
| git checkout -b myfeature | ||
| ``` | ||
|
|
||
| ## Submitting Your First Pull Request |
There was a problem hiding this comment.
This section tells nothing about how to actually submit a pull request from origin to upstream
Co-authored-by: Antonio <bandantonio@users.noreply.github.com>
Description
PR related to First project: Onboarding Contributor Guides
Added the Onboarding Code Contributor Guide
Related issue(s)
#1622