mirrors
/
nnn
mirror of https://github.com/jarun/nnn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nnn/misc/CONTRIBUTING.md

1.3 KiB
Raw Blame History

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, and make sure you aren't breaking any of them.

Feel free to join the Discussions. We highly recommended a discussion before raising a PR.

Coding standard

nnn follows the Linux kernel coding style closely. The C source code uses TABs and the plugins use 4 spaces for indentation.

  • Code changes should not break the patch framework. Please run make checkpatches to ensure.
  • Run make shellcheck if adding/modifying plugins.

CI runs patch framework sanity test and shellcheck. Please watch out for any failures after raising the PR.

Resources

The wiki has some resources for developers you might be interested in: building, debugging...

Communication