Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 3.87 KB
Raw

Contributing

Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. So first of all: Thank you!

Contributions how to

If you'd like to contribute in any shape or form, be it by either reporting or fixing a bug, requesting or implementing a new feature or just generally improving this project, please follow the process outlined below.

Contributions to this project are released to the public under the MIT License.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Note

Found a security vulnerability? Please follow the process outlined in SECURITY.md.

1. Searching and/or Creating an Issue

Do this step in any case - be it that you just want to report something, or if you want to implement a feature or fix yourself.

  1. Search the existing issues to see if someone else didn't already beat you to it. If you find a similar issue, you can upvote it with a 👍 reaction or add your comment.
  2. If no issue exists, create a new Issue to discuss the bug or feature with the community and me. Even if you would like to fix/implement it yourself, this is a good idea to avoid any unnecessary work on your side (in case I already implemented it or have some initial feedback about it).

If I ask you for a pull request, continue with the next steps.

2. Submitting a pull request

Prerequisites for running and testing code

You need to install NodeJS & NPM to be able to test your changes locally as part of the pull request (PR) submission process.

Making and proposing changes

  1. Fork and clone the repository.
  2. Create a new branch: git checkout -b my-branch-name.
  3. Configure and install the dependencies: npm install.
  4. Make sure the tests pass on your machine: npm run test.
  5. Make sure linter passes on your machine: npm run lint (powered by biome.js).
  6. Make your change(s), add tests, and make sure the tests and linter still pass. 6.1. In case the linters fail, use npm run lint:write to automatically fix all automatically fixable issues. Fix the rest manually.
  7. Push to your fork and submit a pull request.
  8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Coding Guidelines

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep the formatting in line with the biome.js rules. (Tip: You can run npm run lint:ci to check the formatting and npm run lint:write to automatically fix all automatically fixable issue.)
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.
  • Don't introduce any unnecessary dependencies. I try to keep this repository as free from dependencies as possible to avoid entering maintenance-hell as well as unnecessarily introducing supply-chain security-threats.

Resources