CONTRIBUTING.md

Contributing to Runespoor Stack

Thank you for taking an interest in contributing! We appreciate you! 🫶🏽

Below are the guidelines on how to help in the best possible way.

Submitting an Issue

Before creating a new issue, please search through open issues using the GitHub issue search bar. You might find the solution to your problem, or can verify that it is an already known issue.

We want a bug-free and best-performing project. That's why we take all reported issues to heart. But please be aware that if we can't reproduce the problem, we won't have a way of locating and adequately fixing it.

Therefore, to solve the problem in the best possible way, please create a minimal repository that reproduces the problem with the least possible code explaining and demonstrating the error.

Without enough information to reproduce the issue, we will close it because we can't recreate and solve it.

Submitting a Pull Request (PR)

Branch Organization

We adopt trunk-based development therefore all Pull Requests are made against the main branch because we do not use separate branches for development or for the versions we release.

Good first issue

The issues marked with ~"good first issue" label are a good starting point to familiarize yourself with the project.

Before solving the problem, please check with the maintainers that the issue is still relevant. Feel free to leave a comment on the issue to show your intention to work on it and prevent other people from unintentionally duplicating your effort.

Sending a Pull Request

Before submitting a pull request, consider MR checklist is fully resolved. You could find it in the PR template. For more information you could read the CODE_REVIEW document.

Make sure the appropriate labels are added Read more information about issue and pull request labels

Local development

Prerequisites

Clone repository:

git clone git@github.com:runespoor-engineering/runespoorstack.git

Specify how to reconcile divergent branches.

git config pull.rebase false

Install pnpm globally:

npm install -g pnpm

Install Rush.js globally:

npm install -g @microsoft/rush

Install package dependencies for all projects, based on the shrinkwrap file that is created/updated using rush update. Reference

rush install

If you want to open a PRs you could fork the repository. For more information read the following docs: Fork a repo, Contributing to projects.

Common commands

Install the dependencies described in your package.json files, and update the shrinkwrap file as needed. Reference

rush update

Do a full, clean build of every project in the repository. Reference

rush rebuild

Delete temporary files created by Rush, including the installed dependencies for all the projects. Reference This is useful if you are having problems and suspect that cache files may be corrupt.

rush purge

Asks a series of questions and then generates a -.json file in the common folder used for CHANGELOG generation.

rush change

Run linters throw all the projects

rush lint

Run linters throw all the projects with autofix

rush lint:fix

Run tests throw all the projects

rush test