aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorToby Vincent <tobyv13@gmail.com>2023-05-15 22:15:39 -0500
committerToby Vincent <tobyv13@gmail.com>2023-05-16 09:56:47 -0500
commit3c045bba05aa1893a127f36f96ee2f0d31c73553 (patch)
tree3c3278ca79c55f1e233a12ffec82ae3e14164a49
parent3289ff0c04cb251a40bc50e4518821eb934a423d (diff)
docs: add CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..8cd575a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing
+
+I welcome any contributions in the form of suggestions, bug reports, pull
+requests, and feedback. This document may provide some guidance if you are
+thinking of helping us.
+
+## Submitting bug reports and feature requests
+
+Bugs reports and feature requests should be submitted to the [public tracker];
+Any questions can be sent to the [projectr-discuss] mailing list.
+
+## Submitting patches
+
+Patches can be sent to the [projectr-devel]. For help sending patches to this
+list, please consult git-send-email.io, or feel free to ask for help in
+[projectr-discuss].
+
+## Conduct
+
+projectr and related community should follow the [Rust Code of Conduct]. For any
+questions or issues related to please submit a post on the [projectr-discuss],
+or feel free to email me directly at [contact@tobyvin.dev].
+
+[contact@tobyvin.dev]: mailto:contact@tobyvin.dev
+[projectr-discuss]: https://lists.sr.ht/~tobyvin/projectr-discuss
+[public tracker]: https://todo.sr.ht/~tobyvin/projectr
+[projectr-devel]: https://lists.sr.ht/~tobyvin/projectr-devel
+[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct