summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2020-12-13 23:33:58 +0100
committerGiampaolo Rodola <g.rodola@gmail.com>2020-12-13 23:33:58 +0100
commitb777a5177d0b8a492fc76320491b0791f25e17a1 (patch)
tree8270466a88fbad4f56c1457f00128dc9ef74f7f7 /CONTRIBUTING.md
parente12d8853cd5d6f44f75ab1bab23c54f7f91b32af (diff)
downloadpsutil-b777a5177d0b8a492fc76320491b0791f25e17a1.tar.gz
add CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..69c9dd94
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+Contributing to psutil project
+==============================
+
+Issues
+------
+
+* The issue tracker is for reporting problems or proposing enhancements related
+ to the **program code**.
+* Please do not open issues **asking for support**. Instead, use the forum at:
+ https://groups.google.com/g/psutil.
+* Before submitting a new issue, **search** if there are existing issues for
+ the same topic.
+* **Be clear** in describing what the problem is and try to be accurate in
+ editing the default issue **template**. There is a bot which automatically
+ assigns **labels** based on issue's title and body format. Labels help
+ keeping the issues properly organized and searchable (by OS, issue type, etc.).
+* To report a **security vulnerability**, use the
+ [Tidelift security contact](https://tidelift.com/security).
+ Tidelift will coordinate the fix and the disclosure of the reported problem.
+
+Pull Requests
+-------------
+
+* The PR system is for fixing bugs or make enhancements related to the
+ **program code**.
+* If you whish to implement a new feature or add support for a new platform it's
+ better to **discuss it first**, either on the issue tracker, the forum or via
+ private email.
+* In order to get acquainted with the code base and tooling, take a look at the
+ **[Development Guide](https://github.com/giampaolo/psutil/blob/master/docs/DEVGUIDE.rst)**.
+* If you can, remember to update
+ [HISTORY.rst](https://github.com/giampaolo/psutil/blob/master/HISTORY.rst)
+ and [CREDITS](https://github.com/giampaolo/psutil/blob/master/CREDITS) file.