Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.71 KB
Raw

Contribution Guide

therun.gg's frontend is open source and under active development. There's a lot to be improved so any help is welcome! This guide gives you an overview of the steps you need to take to contribute to the project.

If you want to contribute to more complicated code, make sure you know about:

  • TypeScript
  • next.js

Find an issue

You can find a good feature to work on with GitHub Issues. Look for the tag good first issue to find an issue that should not be too much work!

If you want to contribute something not in the issues, please create an issue yourself first.

Get in touch

Installing

Before you can contribute, make sure you can run the project locally.

Requirements:

  • node.js version 16 or higher
  • npm version 8 or higher
  • You are familiar with git

Setup

  • Clone this repository
  • Run cp .env .env.local and modify .env.local as you need (default should be fine)
  • Run npm install
  • Run npm run dev
  • Navigate to http://localhost:3000

Contribute

  • Fork the project from the main branch
  • If a GitHub issue does not exist for what you want to contribute, create it first.
  • Change the code to make the change you want
  • Run npm run lint-fix to format your code
  • Create a new Pull Request

License

By contributing to therun.gg, you agree that your contributions will be licensed under its MIT license.