diff options
| author |  Arun Prakash Jana <engineerarun@gmail.com> | 2020-06-19 07:31:54 +0530 |
|---|---|---|
| committer | Arun Prakash Jana <engineerarun@gmail.com> | 2020-06-19 07:35:05 +0530 |
| commit | 28bf18adab7be6d665df6eeb3db66a944727bc05 (patch) | |
| tree | 38ed94bf17de3efe0399ff411f00b46fd4ed5411 /misc | |
| parent | 7a1a4e293e7b3497346eee99294fe24658cbf145 (diff) | |
| download | nnn-28bf18adab7be6d665df6eeb3db66a944727bc05.tar.gz | |
Update contributing guideline
Diffstat (limited to 'misc')
| -rw-r--r-- | misc/CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/misc/CONTRIBUTING.md b/misc/CONTRIBUTING.md new file mode 100644 index 0000000..06c8379 --- /dev/null +++ b/misc/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# 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. + +## Coding standard + +`nnn` follows the Linux kernel coding style closely. The C source code uses TABs and the plugins use 4 spaces for indentation. + +## 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). |