Contribution Guidelines

Thank you so much for wanting to contribute to update-ts-references! Here are a few important things you should know about contributing.

This project takes all contributions through pull requests. Code should not be pushed directly to master.

The following guidelines apply to all contributors.

General Guidelines

Only one logical change per commit
Do not mix whitespace changes with functional code changes
Do not mix unrelated functional changes
When writing a commit message:
- Describe _why_ a change is being made
- Do not assume the reviewer understands what the original problem was
- Do not assume the code is self-evident/self-documenting
- Describe any limitations of the current code
Any significant changes should be accompanied by tests.
The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it.

Commit Message Guidelines

All commits should be structured after the Conventional Commits 1.0.0 convention.

Making Changes

Fork the update-ts-references repository
Install dependencies yarn
Make your changes
Run tests yarn test
Push your changes to a branch in your fork
See our commit message guidelines in this document
Submit a pull request to the repository