Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 3.04 KB

Contributing

Thank you for investing your time in contributing to our project! 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.

Code of conduct

Read our Code of Conduct before contributing

Getting started guides

The readme for this project contains information on how to get started. You may want to also look up the quickstart guide and how to get a free token for 10,000 free minutes of video so you can try out 100ms at your leisure.

Issues

Create a new issue

If you spot a problem with the app, search if an issue already exists . If a related issue doesn't exist, you can open a new issue.

Solve an 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.

Pull Request

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.

Your PR is merged!

Congratulations 🎉 100ms team thanks you 🥳