Before you begin:
- This site is powered by Node.js. Check to see if you're on the version of node we support.
- Have you read the code of conduct?
- Check out the existing issues.
If you spot something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.
Fork using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Fork using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
Fork with GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
Make your changes to the file(s) you'd like to update. Please be sure to update the documentation as well, when adding new features or changing the API.
When you're done making changes and you'd like to propose them for review, open your PR (pull request).
- Once you submit your PR, others from the community will review it with you.
- After that, we may have questions, check back on your PR to keep up with the conversation.
- Did you have an issue, like a merge conflict? Check out our git tutorial on how to resolve merge conflicts and other issues.
You should always review your own PR first.
For content changes, make sure that you:
- Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one).
- Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected.
- This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems.
- Remember that lists and tables can be tricky.
- Review the content for technical accuracy.
- Copy-edit the changes for grammar, spelling, and adherence.
- If there are any failing checks in your PR, troubleshoot them until they're all passing.
We review every single PR. The purpose of reviews is to create the best content we can for people who use this library.
💛 Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time. 💛 Reviews discuss content, not the person who created it. 💛 Reviews are constructive and start conversation around feedback.
We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
As you update your PR and apply changes, mark each conversation as resolved.
Congratulations! The whole community thanks you. ✨
Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.