2021-10-02 07:29:38 +02:00
|
|
|
Project Scope
|
|
|
|
|
-------------
|
2021-09-16 11:32:59 +02:00
|
|
|
|
|
|
|
|
* 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.
|
2021-10-02 07:29:38 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Contribution Guideline
|
|
|
|
|
----------------------
|
|
|
|
|
|
2021-09-16 11:32:59 +02:00
|
|
|
When contributing, make sure:
|
|
|
|
|
|
|
|
|
|
* Your contribution falls under nsxiv's scope and aim
|
|
|
|
|
* You follow the existing code style (see [.editorconfig](.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.
|
|
|
|
|
|
2021-11-03 06:28:12 +01:00
|
|
|
See the [open issues](https://github.com/nsxiv/nsxiv/issues) to find something
|
|
|
|
|
to work on. You can also filter the issues via label:
|
|
|
|
|
|
|
|
|
|
* [Good first issue](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
|
|
|
|
|
(Easy) Issues which do not require much if any experience.
|
|
|
|
|
* [Up for grabs](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22):
|
|
|
|
|
(Intermediate) Issues which are free for anyone who wants to pick it up.
|
|
|
|
|
Might require some experience.
|
|
|
|
|
* [Help wanted](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22):
|
|
|
|
|
(Intermediate/Experienced) Issues where we require some help.
|
