diff options
| author | Théo Zimmermann | 2019-06-25 09:12:45 +0200 |
|---|---|---|
| committer | Théo Zimmermann | 2019-07-11 09:55:10 +0200 |
| commit | 8b25ae74cde213a1ec0e48c12f2ff62aad7c7429 (patch) | |
| tree | a8cd04648bed1227c38412b5791441fdc8b51b04 /dev/README.md | |
| parent | 195772efccbac6663501bd5fff63c318d22ee191 (diff) | |
Refactor and expand contributing guide.
This is almost a full rewrite of the contributing guide. The goal was
to have a more structured, and more exhaustive guide, where all our
processes are documented, and from which all the useful documentation
is linked to.
The document lists contribution types in the order in which it is most
natural to go through them: from contributions to the ecosystem, to
issues, to code contributions, to taking part in the maintenance.
However, it seemed important to not neglect this last part if we want
to ease the onboarding of new maintainers (and not just of occasional
contributors).
A table of content makes it easy to go through the document (which is
too long to be read from begin to end).
The guide documents our processes in the way they are today, without
changing anything, but this should be a good basis to make them evolve
in the future. Insufficiently documented tools and processes are
mentioned as such.
Diffstat (limited to 'dev/README.md')
| -rw-r--r-- | dev/README.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/dev/README.md b/dev/README.md index 9761f7b96f..4cda60a703 100644 --- a/dev/README.md +++ b/dev/README.md @@ -2,7 +2,7 @@ ## Debugging and profiling (`dev/`) -**More info on debugging: [`doc/debugging.md`](doc/debugging.md)** +**More info on debugging: [`dev/doc/debugging.md`](doc/debugging.md)** | File | Description | | ---- | ----------- | |