Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (43 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 3.04 KB

Contributing to HSR Optimizer

We'd love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Communication via discord

We use the #dev channel on discord https://discord.gg/rDmB4Un7qg for communication/questions. Responses on discord will generally be faster than Issues or comments.

Setup

Install NodeJS & NPM

Currently, the best balance between legacy dependencies and future direction is node v22.6.0 - if this changes, it will be reflected in the .node-version file in the root directory. We suggest using a Node version manager such as NVM or FNM to quickly switch between this project and any other node/js project you are working in.

Install project dependencies

npm install If you see install failures due to depedency graph failures, try: npm install --legacy-peer-deps If you still see failures, please report an issue!

Formatter & Linter

See Instructions at #1185 for setup

Confirm your environment is stable and working

npm start from the root directory. In a moment, your default browser should open to the local server and HSR Optimizer will load after a few moments.

We use Github Flow, so all code changes happen through pull requests

Pull requests are the best way to propose changes to the codebase. Steps to create a pull request:

  1. Fork the hsr-optimizer repo and create your personal branch from beta.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints with npm run lint
  6. Issue that pull request!

Report bugs using Github's issues

Report a bug by opening a new issue. Bugs should include reproduction steps, screenshots, and if possible, the metadata to reproduce the issue. Uploading the save file is helpful as well.

Your first issue & pull request

  • Check current issues in the BACKLOG
  • Priority stack ranking and rough project status can be found in the PRIORITY BOARD
  • Find an issue you're interested in and comment on it that it's in progress. Feel free to ping fribbels on the discord server as well to discuss any ambiguities.

After you have forked the repo and switched to the beta branch, create your working branch:

git checkout -b [feature|fix]/[your-branch-name]

Suggested commit message format

Try to use this format https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 for commit messages for clear history tracking.