From 0a5a40c12cbc35748010dd8e32ddf449a3afe5fa Mon Sep 17 00:00:00 2001 From: Alex Pliutau Date: Tue, 24 Sep 2024 11:51:26 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3b36c7b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +First off all, thank you for considering contributing to this project. It's people like you that make it such a great tool. + +Keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that mean less work for you. + +Some basic suggestions to get you started: +- Make sure the PR is up-to-date with the latest changes in the main branch. +- Make sure the PR passes all the tests. +- Make sure the PR passes the linter. +- Make sure the PR is well documented and formatted. +- Make sure the PR is well tested.