Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 1.22 KB

Contributing

This project is open source and contributions are welcome! The guidelines aren't fully written yet, but in general, you can follow the steps below to contribute:

  1. Fork the repository
  2. Clone the repository
  3. Run yarn install to install dependencies (we use Yarn, please don't use NPM since it will cause issues with the lockfile)
  4. Make your changes
  5. Run yarn build to build the project
  6. Run yarn test to run tests (eventually we will have tests)
  7. Make sure everything works
  8. Commit your changes
  9. Push your changes
  10. Open a pull request
  11. Wait for a maintainer to review your pull request - get a cookie or something while you wait. You deserve it 👾.

Notes

  • We use commitizen to format commit messages. Please use yarn commit to commit your changes (or if you have commitizen installed globally, you can use git commit too).
  • We will eventually have a linter installed - please follow the linter rules when contributing.
  • We will eventually have tests - please make sure your code passes the tests before opening a pull request.
  • We will eventually have a code of conduct - please follow the code of conduct when contributing.