Skip to content

Commit 6512dfe

Browse files
committed
Update TOC, add documentation section (#375)
1 parent 220f650 commit 6512dfe

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ The following is a set of guidelines for contributing to Metafacture and how to
99
[How can I contribute?](#how-can-i-contribute)
1010
* [Reporting Bugs](#reporting-bugs)
1111
* [Suggesting Enhancements](#suggesting-enhancements)
12-
* [Pull Requests](#pull-requests)
13-
* [Conventions](#conventions)
12+
* [Contributing Code](#contributing-code)
13+
* [Improving Documentation](#improving-documentation)
1414

1515
[Maintainer Guidelines](#maintainer-guidelines)
1616
* [Board and Issues](#board-and-issues)
1717
* [From Backlog to Done](#from-backlog-to-done)
1818
* [Definition of Ready](#definition-of-ready)
1919
* [Definition of Done](#definition-of-done)
20-
* [Making a Release](#making-a-release)
20+
* [Releasing Metafacture](#releasing-metafacture)
2121

2222

2323
## How can I contribute?
@@ -62,7 +62,7 @@ Provide the following information:
6262
* **Explain why this enhancement would be useful** to most users.
6363
* **List any other applications where this enhancement exists.**
6464

65-
### Contributing code
65+
### Contributing Code
6666

6767
The overall code contribution process is:
6868

@@ -112,6 +112,10 @@ The [metafacture-fix build](https://github.com/metafacture/metafacture-fix/blob/
112112

113113
The code is automatically [quality-checked on sonarcloud.io](https://sonarcloud.io/dashboard?id=org.metafacture%3Ametafacture-core) when pushed to GitHub.
114114

115+
### Improving Documentation
116+
117+
If you notice errors, inconsistencies or missing parts in the documentation, we are very happy about improvements. Please follow the general process for contributing code from above, or open an issue.
118+
115119
## Maintainer Guidelines
116120

117121
### Board and Issues

0 commit comments

Comments
 (0)