| 1 | Contribution Guideline |
| 2 | ---------------------- |
| 3 | |
| 4 | The scope and aim of nsxiv are: |
| 5 | |
| 6 | * Bug fixes and maintenance |
| 7 | * Prioritize extensibility and simplicity |
| 8 | * Do not make the codebase more complex, keep it simple to hack on |
| 9 | * Do not add extra dependency (if we do, add compile time switch to disable it) |
| 10 | * New features may be added if it cannot be achieved (easily) via a shell script, |
| 11 | doesn't break backwards compatibility and doesn't violate any of the above rules. |
| 12 | |
| 13 | When contributing, make sure: |
| 14 | |
| 15 | * Your contribution falls under nsxiv's scope and aim |
| 16 | * You follow the existing code style (see [.editorconfig](.editorconfig)) |
| 17 | * You open the pull request from a new branch, not from master |
| 18 | |
| 19 | If your contribution is not suitable for general use, it will not be included in nsxiv. |
| 20 | For changes that are very much up to preference, such as changing values in config.h, |
| 21 | please do not open a pull request unless you have an objective explanation. |
| 22 | |
| 23 | See [TODO.md](TODO.md) or the [open issues](https://github.com/nsxiv/nsxiv/issues) to find something to work on. |