Skip to content

Commit

Permalink
📖 Mention git commit emojis in contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
o-laurent committed Oct 14, 2023
1 parent 8bc0da8 commit 6f54bd5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ and linted before committing.
Before submitting a final pull request, that we will review, please try your
best not to reduce the code coverage and document your code.

If you implement a method, please add a reference to the corresponding paper in the ["References" page](https://torch-uncertainty.github.io/references.html).
Try to include an emoji at the start of each commit message following the suggestions
from [this page](https://gist.github.com/parmentf/035de27d6ed1dce0b36a).

If you implement a method, please add a reference to the corresponding paper in the
["References" page](https://torch-uncertainty.github.io/references.html).

### Datasets & Datamodules

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

_TorchUncertainty_ is a package designed to help you leverage uncertainty quantification techniques and make your deep neural networks more reliable. It aims at being collaborative and including as many methods as possible, so reach out to add yours!

:construction: _TorchUncertainty_ is in early development :construction: - expect massive changes, but reach out and contribute if you are interested in the project! **Please raise an issue if you have any bugs or difficulties.**
:construction: _TorchUncertainty_ is in early development :construction: - expect changes, but reach out and contribute if you are interested in the project! **Please raise an issue if you have any bugs or difficulties.**

---

Expand Down
3 changes: 3 additions & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ and linted before committing.
Before submitting a final pull request, that we will review, please try your
best not to reduce the code coverage and do document your code.

Try to include an emoji at the start of each commit message following the suggestions
from `this page <https://gist.github.com/parmentf/035de27d6ed1dce0b36a>`_.

If you implement a method, please add a reference to the corresponding paper in the
`references page <https://torch-uncertainty.github.io/references.html>`_.

Expand Down

0 comments on commit 6f54bd5

Please sign in to comment.