Skip to content

Commit 3ef8ebc

Browse files
authored
Create CONTRIBUTING.md
1 parent 160423e commit 3ef8ebc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Issues and PRs are welcome!
2+
3+
# Issues
4+
- Please open issues with clear descriptions of any problem or feature request.
5+
- If the issue describes a problem or a bug, please include an example that exposes the problem.
6+
- Please make sure that you are testing your code on the latest released version of the package before opening a bug report.
7+
- Discussions and help requests may use [Github discussions](https://github.com/JuliaControl/ControlSystems.jl/discussions), [discourse.julialang.org](https://discourse.julialang.org/) or the JuliaLang slack channel rather than an issue on this repository.
8+
9+
# Pull requests
10+
- Please consider **opening an issue discussing your proposed changes** before submitting a PR.
11+
- Please make **changes only related to a single concept**, and avoid fixing several different things in a single PR. **Do not run an automatic code formatter** on code that is not otherwise actively modified by the PR.
12+
- Pull requests that add **dependencies are unlikely to be accepted** unless there is a very good motivation for the addition and the added dependency is both lightweight, stable and well maintained. Contributions that add significant new features and require additional dependencies are often better contributed in the form of a separate package.

0 commit comments

Comments
 (0)