Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

46 lines (35 loc) · 2.02 KB
Raw

Contributing

We're so excited that your interesting in contributing to your project! 🎉

We understand that contributing to an open source project involves your time and labor, and we appreciate that you've chosen our project. In order to maintain a safe space for all, everyone is expected to follow the code of conduct.

Submitting an issue

Note: Please see our security policy to report a potential vulnerability rather than using the public issue queue.

If you believe you have discovered an issue with the application, please check the issue queue to see if it has already been reported. You can open a new issues if you are unable to find one. Please complete the

If you find a problem with the project, [search if an issue already exists][1]. If a related issue doesn't exist, you can open a [new issue][2].

Pull request workflow

We follow the GitHub flow workflow for project development.

GitHub flow is a lightweight, branch-based workflow. The GitHub flow is useful for everyone, not just developers.

  1. Check out the main branch and pull down the latest code
  2. Create a new branch off of the latest from main using a short, descriptive branch name (e.g. update-code-of-conduct)
  3. Make your code changes
  4. When you are ready to have your changes reviewed, push your code to GitHub and open a pull request. Make sure to complete all sections of the pull request template.
  5. Wait for automated checks to complete and address any failures.
  6. Once all automated checks have passed, a maintainer will review your changes.
  7. After your pull request has been approved, it will be merged. We utilize GitHub's squash and merge method in order to maintain a cleaner commit tree.