Skip to content

Commit

Permalink
docs instructions for development/contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
erexer committed Nov 12, 2024
1 parent a081d04 commit c2fbd0c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ __I found a bug!__

__I fixed a bug!__
* First of all, thanks!
* Make sure that you're running the changed files and/or new files through pre-commit by running `$ pip install pre-commit` and `$ pre-commit install` in the mosartwmpy repo. Pre-commit will now automatically check your file formatting when you `$ git commit`.
* Open a [new Pull Request] with the fix. Ensure the description clearly outlines the bug and the solution. Include the Issue number if applicable.

__I created a new feature!__
* You're the best!
* Consider opening a [new Issue] to describe use cases for the new feature. This will offer a platform for discussion and critique.
* Make sure that you're running the changed files and/or new files through pre-commit by running `$ pip install pre-commit` and `$ pre-commit install` in the mosartwmpy repo. Pre-commit will now automatically check your file formatting when you `$ git commit`.
* Then, open a [new Pull Request] with clear documentation of the methodology. Be sure to include new unit tests if appropriate.

The [IM3] team truly appreciates and encourages community involvement. We're all in this together!
The [IM3] team truly appreciates and encourages community involvement. We're all in this together!

0 comments on commit c2fbd0c

Please sign in to comment.