Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.21 KB

Contributing

Thanks for considering contributing! This project would not be what it is without the support of the community.

Issues

  • If reporting a bug, please include the operating system used, any relevant information about the tech stack, and the configuration used.

Pull requests

  • Before opening the PR, make sure you've built and run it, done the tests locally, and run the formatter/linter.
  • Feel free to pop in on Discord to ask for help or clarification on anything related to this project.
  • If possible, check that someone else hasn't recently said that they've taken up an issue.
  • Try to keep your PR focused on a single feature/bug/etc, don't mix them together.
  • Make pull requests from a feature branch on your own fork instead of from main.

How to create and use a fork:

  1. Fork this project.
  2. Clone your fork: git clone <fork>.
  3. Add a remote for this project: git remote add upstream <url>.
  4. Your fork is ready to go, to create a pull request you can:
    • Make sure you're starting from main: git switch main.
    • Grab any new commits: git pull upstream dev.
    • Create a new branch: git switch -c <new-branch>.
    • And you're good to go!