aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Mario <marioortizmanero@gmail.com>2020-06-18 05:36:27 +0200
committerGravatar GitHub <noreply@github.com>2020-06-18 09:06:27 +0530
commit9b5b2b544c50f5c564df9b5b43785568c7ea9dd1 (patch)
treef30030705df2cd8fbe5e4e82e71a80cfc789f982
parentd7e5e420eb3c5c4ac58c88c7892e05178f178031 (diff)
downloadnnn-9b5b2b544c50f5c564df9b5b43785568c7ea9dd1.tar.gz
Initial CONTRIBUTING.md (#655)
-rw-r--r--CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..47e0efe
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing
+Contributions to nnn are welcome! There's always an open issue with the current ToDo list, which contains the proposed features for the next release you can get your hands on. Any small changes or ideas should go in there, rather than in a separate issue.
+
+Before suggesting changes, please read a bit about [the design principles nnn follows](https://github.com/jarun/nnn/wiki#design), and make sure you aren't breaking any of them.
+
+## Resources
+The [wiki](https://github.com/jarun/nnn/wiki/Developer-guides) has some resources for developers you might be interested in: building, debugging...
+
+## Communication
+* [Gitter chat](https://gitter.im/jarun/nnn)
+* [GitHub team](https://github.com/nnn-devs) (if you plan on contributing regularly, ask for an invitation).