Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 4.1 KB
Raw

Contributing to <mux-elements/>

Code of Conduct

Before contributing, please read and make sure you follow our Code of Conduct.

Questions

Have a question? Want to start a discussion? For now, you can simply Open a New Issue, prefix the title with "Question: [...]" or "Discussion: [...]", and add the discussion and/or question label to the issue.

Bugs and Issues

If you think you've found a bug, make sure you review and fill out a Bug Report before starting any work. This will ensure for both yourself and the maintainers that the issue in question can be properly confirmed, reproduced, smoke tested, etc. Once done, go ahead and follow our Submitting a Pull Request guide.

Documentation Updates

Our documentation update request requirements are similar to the requirements for Bugs and Issues, except you'll want to review and fill out a Docs Request instead of a Bug Report.

Feature Requests

For feature requests, you can start by reviewing and filling out a Feature Request. Unlike bug fixes, Feature Requests will likely require more discussion from the maintainers, including whether or not it is consistent with our overall architectural goals, our timeline and priorities, and the like. Once done, assuming you've gotten a 👍 to work on the feature, go ahead and follow our Submitting a Pull Request guide.

Submitting a Pull Request

Before submitting a pull request, make sure you've reviewed and filled out an appropriate Issue. We recommend doing this before starting any work, just in case an issue already exists, or it's unlikely the maintainers will be able to review the PR because it e.g. lacks sufficient reproduction steps. In addition, we recommend the following:

  1. We use semantic releases/commits, please try to name your branch and prefix your commits according to the type of changes you're making, and try to be as descriptive as possible in your commit messages. For example:
  • For Bug Fixes: fix/my-fix-for-foo
  • For Features: feat/mux-video-feat-bar
  • For Documentation Updates: docs/mux-audio-example-for-baz

  1. Make sure you base your branch off of the latest in main, e.g.

    git checkout -b fix/my-fix-for-foo main

  2. When issuing your Pull Request, be sure to Link it to the corresponding issue(s)

  3. Add any additional comments to your PR's description that will help the reviewer(s), such as call outs, open questions, areas that merit extra attention, etc.

  4. When addressing any feedback, you can simply add it as new commits.

  5. We use a rebase strategy when merging PR branches into main. If your branch has merge conflicts, if possible, please try to resolve them by doing a git rebase onto main and then doing a git push --force-with-lease. For example:

    git fetch upstream
git rebase --onto main your-old-base fix/my-fix-for-foo
... resolve any conflicts
git push --force-with-lease

    (See the git docs for more details on git rebase --onto)