Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on 100ms Docs If you don't know where to start contributing, ask us on our Discord channel.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Read our Code of Conduct before contributing
We have created a very detailed guide to setup this repo locally you can checkout it out here
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. Leave a comment on the issue asking if you can pick up the issue so maintainers knowing you want to work on it.
When you're done making the changes, open a pull request, often referred to as a PR.
- Fill out the PR description summarizing your changes so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
- 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.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉 100ms team thanks you 🥳