mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-25 03:06:31 -05:00
Improve CONTRIBUTING.md
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
(cherry picked from commit f77f9fac19
)
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
parent
8bc66bd81a
commit
4059ad6834
1 changed files with 68 additions and 27 deletions
|
@ -1,37 +1,78 @@
|
||||||
# Contributing
|
# Contributing to HedgeDoc
|
||||||
|
|
||||||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
Thanks for your help in improving the HedgeDoc project!
|
||||||
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
|
Please note we have a [code of conduct][code-of-conduct], please follow it in all your interactions with the project.
|
||||||
interactions with the project.
|
|
||||||
|
|
||||||
## Pull Request Process
|
## Ways of contributing
|
||||||
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
|
### Do you have questions about the project?
|
||||||
|
|
||||||
|
* Feel free to post your question on our [community forum](community-forum) or join
|
||||||
|
our [matrix community chat][matrix-support].
|
||||||
|
|
||||||
|
### Did you find a bug?
|
||||||
|
|
||||||
|
* **Ensure the bug wasn't already reported** by searching on GitHub under [Issues](issues).
|
||||||
|
|
||||||
|
* If you're unable to find an open issue addressing the problem, [open a new one](new_issue). Be sure to use one of the
|
||||||
|
templates we provide if your request applies to them.
|
||||||
|
|
||||||
|
### Did you write a patch that fixes a bug?
|
||||||
|
|
||||||
|
* Open a new GitHub pull request with the patch. See the section [submitting a pull request](#submitting-a-pull-request)
|
||||||
|
for details on this.
|
||||||
|
|
||||||
|
* Ensure the PR description is precise about the problem and your solution. Just fill out our template. That should
|
||||||
|
cover the most important information.
|
||||||
|
|
||||||
|
### Do you intend to add a new feature or change an existing one?
|
||||||
|
|
||||||
|
* Suggest your idea via a new GitHub issue. After a confirmation about your idea, you can start writing code. Our
|
||||||
|
maintainers and other project developers can provide useful details about the architecture and show you relevant
|
||||||
|
issues and discussions.
|
||||||
|
|
||||||
|
### Do you want to work on translations?
|
||||||
|
|
||||||
|
* If you want to improve a translation or add a new translation altogether, we handle those via [POEditor](poeditor).
|
||||||
|
|
||||||
|
HedgeDoc is a volunteer effort. We encourage you to pitch in and to help us making this project even better.
|
||||||
|
|
||||||
|
## Certificate of Origin
|
||||||
|
|
||||||
|
By contributing to this project you agree to
|
||||||
|
the [Developer Certificate of Origin (DCO)](docs/legal/developer-certificate-of-origin.txt). This document was created
|
||||||
|
by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the
|
||||||
|
contribution. The DCO is a legally binding statement,
|
||||||
|
please [read it carefully](docs/legal/developer-certificate-of-origin.txt).
|
||||||
|
|
||||||
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:
|
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>
|
Signed-off-by: Random J Developer <random@developer.example.org>
|
||||||
````
|
```
|
||||||
|
|
||||||
Use your real name (sorry, no pseudonyms or anonymous contributions).
|
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)
|
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
|
||||||
like `git config --global alias.ci 'commit -s'`. Now you can commit with
|
You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
|
||||||
`git ci` and the commit will be signed.
|
like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
|
||||||
|
|
||||||
|
## Submitting a Pull Request
|
||||||
|
|
||||||
|
1. Submit an issue describing your proposed change. We will try to respond to your issue promptly.
|
||||||
|
2. Fork this repo, develop and test your code changes. Ensure you signed all your commits (see above for details).
|
||||||
|
3. Submit a pull request against this repo's `master` branch.
|
||||||
|
4. Your branch may be merged once all configured checks pass.
|
||||||
|
|
||||||
|
[code-of-conduct]: ./CODE-OF-CONDUCT.md
|
||||||
|
|
||||||
|
[community-forum]: https://community.hedgedoc.org
|
||||||
|
|
||||||
|
[matrix-support]: https://matrix.to/#/#hedgedoc:matrix.org
|
||||||
|
|
||||||
|
[issues]: https://github.com/hedgedoc/hedgedoc/issues
|
||||||
|
|
||||||
|
[new_issue]: https://github.com/hedgedoc/hedgedoc/issues/new/choose
|
||||||
|
|
||||||
|
[poeditor]: https://translate.hedgedoc.org
|
||||||
|
|
Loading…
Reference in a new issue