Contributing#

Tip

If this is your first time contributing to an open source project, it is a good idea to read MDN’s Basic etiquette for open source projects first. There are a few best practices to adopt that will help ensure that you and the other project contributors feel valued and safe, and stay productive.

  1. Fork the repo on GitHub

  2. Create a new branch for the feature you are adding or the issue you are fixing

    Tip

    Base the new branch off the nightly branch. It will make your life easier when you submit the PR!

  3. Make changes, push commits, etc.

  4. Files should contain an empty line at the end.

  5. Document your code!

  6. Test your code!

  7. When ready create a PR against the nightly branch.

    Hint

    If you accidentally make your PR against a different branch, a bot will comment letting you know it’s on the wrong branch. Don’t worry. You can edit the PR to change the target branch. There is no reason to close the PR!

    Note

    Draft PRs are also welcome as you work through issues. The benefit of creating a draft PR is that an automated build can run in a github runner.

    Attention

    Do not expect partially complete PRs to be merged. These topics will be considered before merging.

    • Does the code follows the style guidelines of the project?

      Tip

      Look at examples of existing code in the project!

    • Is the change value added?

    • Is the code well commented?

    • Were documentation blocks updated for new or modified components?

    Note

    Developers and maintainers will attempt to assist with challenging issues.