Skip to content

Commit

Permalink
docs: add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
notaphplover committed Oct 16, 2024
1 parent 5965e6b commit a4b68e5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to Inversify monorepo

## Guidelines

- Please follow [unit testing guidelines](./docs/testing/unit-testing.md) when testing your modules.

- Please wite [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Conventional commits are enforced via git hooks and gh actions thanks to [commitlint](https://commitlint.js.org/). The `commit` npm script might be helpful for newcomers.

- Create an issue before sending a PR.

- Feel free to ask for help from other members of the InversifyJS team via the chat / mailing list or github issues.

0 comments on commit a4b68e5

Please sign in to comment.