mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-12-23 19:51:59 +00:00
38 lines
1.9 KiB
Markdown
38 lines
1.9 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||
|
|
email, or any other method with the owners of this repository before making a change.
|
||
|
|
|
||
|
|
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your
|
||
|
|
interactions with the project.
|
||
|
|
|
||
|
|
## Pull Request Process
|
||
|
|
1. Ensure you signed all your commits with Developer Certificate of Origin (DCO).
|
||
|
|
2. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
||
|
|
build.
|
||
|
|
3. Update the README.md with details of changes to the interface, this includes new environment
|
||
|
|
variables, exposed ports, useful file locations and container parameters.
|
||
|
|
4. Increase the version numbers in any examples files and the README.md to the new version that this
|
||
|
|
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
||
|
|
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
||
|
|
do not have permission to do that, you may request the second reviewer to merge it for you.
|
||
|
|
|
||
|
|
## Sign your work
|
||
|
|
|
||
|
|
We use the Developer Certificate of Origin (DCO) as a additional safeguard
|
||
|
|
for the CodiMD project. This is a well established and widely used
|
||
|
|
mechanism to assure contributors have confirmed their right to license
|
||
|
|
their contribution under the project's license.
|
||
|
|
Please read [docs/legal/developer-certificate-of-origin.txt][dcofile].
|
||
|
|
If you can certify it, then just add a line to every git commit message:
|
||
|
|
|
||
|
|
````
|
||
|
|
Signed-off-by: Random J Developer <random@developer.example.org>
|
||
|
|
````
|
||
|
|
|
||
|
|
Use your real name (sorry, no pseudonyms or anonymous contributions).
|
||
|
|
If you set your `user.name` and `user.email` git configs, you can sign your
|
||
|
|
commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
|
||
|
|
like `git config --global alias.ci 'commit -s'`. Now you can commit with
|
||
|
|
`git ci` and the commit will be signed.
|