penwing/zeniba-nsxiv
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
zeniba-nsxiv/CONTRIBUTING.md
N-R-K 1dc936d0ee
Move over to nsxiv-extra (#100) 
* change wiki links to nsxiv-extra

* add User patches section

* link to Project-Scope and Contribution-Guideline directly
2021-10-01 23:29:38 -06:00

1.1 KiB
Raw Blame History

Contribution Guideline

Project Scope

  • Bug fixes and maintenance
  • Prioritize extensibility and simplicity
  • Do not make the codebase more complex, keep it simple to hack on
  • Do not add extra dependency (if we do, add compile time switch to disable it)
  • New features may be added if it cannot be achieved (easily) via a shell script, doesn't break backwards compatibility and doesn't violate any of the above rules.

Contribution Guideline

When contributing, make sure:

  • Your contribution falls under nsxiv's scope and aim
  • You follow the existing code style (see .editorconfig)
  • You open the pull request from a new branch, not from master

If your contribution is not suitable for general use, it will not be included in nsxiv. For changes that are very much up to preference, such as changing values in config.h, please do not open a pull request unless you have an objective explanation.

See TODO.md or the open issues to find something to work on.