| 1 | Project Scope |
| 2 | ------------- |
| 3 | |
| 4 | * Bug fixes and maintenance |
| 5 | * Prioritize extensibility and simplicity |
| 6 | * Do not make the codebase more complex, keep it simple to hack on |
| 7 | * Do not add extra dependency (if we do, add compile time switch to disable it) |
| 8 | * New features may be added if it cannot be achieved (easily) via a shell script, |
| 9 | doesn't break backwards compatibility and doesn't violate any of the above rules. |
| 10 | |
| 11 | Note: Since we aim to be a drop-in replacement for sxiv, we intend to keep all |
| 12 | sxiv's behaviors/features even in cases where removing them would make the |
| 13 | code-base simpler. |
| 14 | |
| 15 | |
| 16 | Contribution Guideline |
| 17 | ---------------------- |
| 18 | |
| 19 | When contributing, make sure: |
| 20 | |
| 21 | * Your contribution falls under nsxiv's scope and aim |
| 22 | * You follow the existing code style (see [.editorconfig](.editorconfig)) |
| 23 | * You open the pull request from a new branch, not from master |
| 24 | |
| 25 | If your contribution is not suitable for general use, it will not be included in nsxiv. |
| 26 | For changes that are very much up to preference, such as changing values in config.h, |
| 27 | please do not open a pull request unless you have an objective explanation. |
| 28 | |
| 29 | See the [open issues](https://github.com/nsxiv/nsxiv/issues) to find something |
| 30 | to work on. You can also filter the issues via label: |
| 31 | |
| 32 | * [Good first issue](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22): |
| 33 | (Easy) Issues which do not require much if any experience. |
| 34 | * [Up for grabs](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22): |
| 35 | (Intermediate) Issues which are free for anyone who wants to pick it up. |
| 36 | Might require some experience. |
| 37 | * [Help wanted](https://github.com/nsxiv/nsxiv/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22): |
| 38 | (Intermediate/Experienced) Issues where we require some help. |