Create CONTRIBUTING.md

plutov · Sep 24, 2024 · ffca796 · ffca796
1 parent fe24e04
commit ffca796
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/CONTRIBUTING.md 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.