gianmarco
/
nsxiv
Archived
1
0
Fork 0
Code Issues Pull Requests Activity
This repository has been archived on 2024-02-08. You can view files and clone it, but cannot push or open issues/pull-requests.
nsxiv/CONTRIBUTING.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

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-02 07:29:38 +02:00
Project Scope
-------------
Rename, Update Docs and Prepare for Release (#9) Co-authored-by: Guilherme Rugai Freire <41879254+GRFreire@users.noreply.github.com> Co-authored-by: N-R-K <79544946+N-R-K@users.noreply.github.com> Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: Arthur Williams <taaparthur@gmail.com> Co-authored-by: eylles <ed.ylles1997@gmail.com>
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.
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-02 07:29:38 +02:00
clarify project goals (#173) Closes: https://github.com/nsxiv/nsxiv/issues/148
2021-12-01 13:24:45 +01:00
Note: Since we aim to be a drop-in replacement for sxiv, we intend to keep all
sxiv's behaviors/features even in cases where removing them would make the
code-base simpler.
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-02 07:29:38 +02:00
Contribution Guideline
----------------------
Rename, Update Docs and Prepare for Release (#9) Co-authored-by: Guilherme Rugai Freire <41879254+GRFreire@users.noreply.github.com> Co-authored-by: N-R-K <79544946+N-R-K@users.noreply.github.com> Co-authored-by: NRK <nrk@disroot.org> Co-authored-by: Arthur Williams <taaparthur@gmail.com> Co-authored-by: eylles <ed.ylles1997@gmail.com>
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.
add links to labels in CONTRIBUTING (#154)
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.