Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.01 KB

Contributing to Inversify

Setup

1 Clone your fork of the repository

git clone https://github.com/YOUR_USERNAME/InversifyJS.git

2 Install npm dependencies

npm install

3 Run build process

npm test

Guidelines

  • Please try to combine multiple commits before pushing

  • Please use TDD when fixing bugs. This means that you should write a unit test that fails because it reproduces the issue, then fix the issue and finally run the test to ensure that the issue has been resolved. This helps us prevent fixed bugs from happening again in the future

  • Please keep the test coverage at 100%. Write additional unit tests if necessary

  • Please create an issue before sending a PR if it is going to change the public interface of InversifyJS or includes significant architecture changes

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