From 3a2396a11230ba328652663706275d28a65dddc2 Mon Sep 17 00:00:00 2001 From: Michele Cereda Date: Wed, 24 Sep 2025 00:05:59 +0200 Subject: [PATCH] chore(kb): add article about controbuting.md --- knowledge base/contributingmd.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 knowledge base/contributingmd.md diff --git a/knowledge base/contributingmd.md b/knowledge base/contributingmd.md new file mode 100644 index 0000000..99a4c5c --- /dev/null +++ b/knowledge base/contributingmd.md @@ -0,0 +1,29 @@ +# CONTRIBUTING.md + +`CONTRIBUTING.md` files should be put in one's repository or website.
+It provides potential project contributors with a short guide to how they can help with the project. + +## TL;DR + +It is convention to: + +- Name the file `CONTRIBUTING.md` (all uppercase). +- Put the file in the project's root directory. + +## Further readings + +### Sources + +- [How to Build a CONTRIBUTING.md] + + + + + + + + +[How to Build a CONTRIBUTING.md]: https://mozillascience.github.io/working-open-workshop/contributing/