Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

26 lines (20 loc) · 1.52 KB

Contributing to Startrack

First off, well done for getting here, and thank you for taking the time to contribute to my project. You're amazing!

Create an issue first

Please use the feature request template, and tell us you're happy to handle this in a PR. This is usually fine, but wait for the needs triage label to be removed first. If it's a minor fix, go ahead and create the PR without creating an issue.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository. When you create a commit we kindly ask you to follow the Gitmoji convention. You can see the possible emojis on their website, and you can use the VSCode extension to easily add them to your commit message. Please don't use other emojis. Use this format:

[EMOJI] [COMMIT MESSAGE]

Please only use one emoji per commit message. It should be placed at the start, and seperated from the text with a space.

Setting up a development environment

  • Fork the repo
  • Clone your fork
  • cd into the fork
  • Install dependencies by running yarn
  • Start nextjs in development by running yarn dev

You will not be able to use authentication, due to the requirement of API keys, but you can make UI or content changes

License

By contributing your code to the startrack GitHub repository, you agree to license your contribution under the LGPL-2.1 license.