diff --git a/CHANGES.md b/CHANGES.md index cc7f46f0..ed36f9c0 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Added +- Add Contributing Guidelines for skorch. (#1087) ### Changed ### Fixed diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..a8992b82 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +.. image:: https://github.com/skorch-dev/skorch/blob/master/assets/skorch_bordered.svg + :width: 30% + +=========================== +How to Contribute to Skorch +=========================== + +We ❤️ contributions from the open-source community! Please look at the contributing guidelines below: + +1. Firstly, explore the project documentation and open issues before opening a PR. + +2. Provide clear commit messages before submitting a PR and remember to add your changes to `CHANGES.md `. + +3. Be patient and suggest solutions in a collaborative manner. + +4. Keep interactions nice and positive, even if your contribution is not accepted. + +To begin contributing, you need to clone the repository from source and follow the steps as described in the `README `_ + diff --git a/README.rst b/README.rst index 78f0dc91..7d6d05fe 100644 --- a/README.rst +++ b/README.rst @@ -290,4 +290,4 @@ Communication - Slack: We run the #skorch channel on the `PyTorch Slack server `_, for which you can `request access - here `_. + here `_. \ No newline at end of file