Add a section in CONTRIBUTING.org mandating a changelog entry in every
PR. This is done to share the workload of maintainers and streamline the
merge process as suggested by @kain88-de in #8686.
Based on discussion in #8686, introduces a structured PR review process
that community members can follow. The PR process currently borne by
collaborators is split into two phases, review and merge, that can be
completed by different people thus allowing for better scalability.
Also replaces occurrences of "Pull-Request" in CONTRIBUTING.org with
"Pull Request" or "PR" for readability.
Previously we entered the CUSTOM IDs manually into the
documentation files to fix the html export.
However today this is done automatically during export.
In this case the manually added ids are interfering
with this process and consequently are visible in the
web pages. Therefore I have removed them again.
Since org 9 internal links must be declared either as #customID
or textTargetOrFullTextSearch. Relative path links must
be either file:relative/path or ./relative/path. Many links
are using the #customID form to trigger a full text search which is not
defined as to the org documentation. In addition relative file paths are
declared as relative/path which is also not defined. If this is done
the html export can fail. Therefore these links must be corrected
for the files where they break the html export.
Fixes#8054 for all spacemacs documentation files.
This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file
into a new `CONTRIBUTING.org` file. It also refactors the content to be
more organized and make its navigation more goal-oriented.
Github displays a link to the `CONTRIBUTING.*` file when people are
opening new issues or proposing new PRs. This file is important because
it is the entry-point to contributions guidelines for most of the users.
The current setup is non-optimal, even broken, as it adds a level of
indirection, and points to a contributing file that has broken
links (due to the new documentation format). The possible drawback of
the proposed solution is that I'm not sure if it is possible to include
it into the new online documentation as it is not in `doc/` folder.
The other possibility is to keep a small `CONTRIBUTING.md` file, as it
is now, pointing to the new documentation system (once online), but I'm
preferring the proposed solution for the following reasons:
- People that are willing to contribute will probably open Github
first (for forking, creating PR, etc), not the online documentation.
- It has one level of indirection less when people click on the
guidelines guide from a new issue/PR.
- `CONTRIBUTING.*` is by convention a special kind of file on github, so
it's valid reason to break the rule and not having it in the `doc/`
folder.
duianto
Lucius Hu
syl20bnr
Robert O'Connor
Maximilian Wolff
JAremko
emacspace
Anton-Latukha
Codruț Constantin Gușoi
Nikolai Myllymäki
Benjamin Reynolds
person808
Rory O’Kane
Muneeb Shaikh
Fabien Dubosson