From f77f9fac19e6ffbcf41e00b17791ef4d042cad3b Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 18 Nov 2020 12:56:59 +0100 Subject: Improve CONTRIBUTING.md Signed-off-by: David Mehren Co-authored-by: Erik Michelson --- CONTRIBUTING.md | 76 ++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 51 insertions(+), 25 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9637979f..79461f25 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,42 +1,68 @@ -# Contributing +# Contributing to HedgeDoc -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. +Thanks for your help in improving the HedgeDoc project! -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. -## Pull Request Process +## Ways of contributing +### Do you have questions about the project? -1. Ensure you signed all your commits with Developer Certificate of Origin (DCO). +* Feel free to post your question on our [community forum](community-forum) or join our [matrix community chat][matrix-support]. -2. Ensure any install or build dependencies are removed before the end of the layer when doing a - build. +### Did you find a bug? -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. +* **Ensure the bug wasn't already reported** by searching on GitHub under [Issues](issues). -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/). +* 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. -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. +### Did you write a patch that fixes a bug? -## Sign your work +* 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 HedgeDoc 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: -```git +``` Signed-off-by: Random J Developer ``` 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. + +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. + +## 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 -- cgit v1.2.3 From 2432091fb622077592b948763cf325dee7dd3ee0 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 18 Nov 2020 13:31:20 +0100 Subject: Fix introductory sentence Signed-off-by: David Mehren --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79461f25..21eac494 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing to HedgeDoc -Thanks for your help in improving the HedgeDoc project! +HedgeDoc is a volunteer effort. +We encourage you to pitch in and to help us making this project even better! Please note we have a [code of conduct][code-of-conduct], please follow it in all your interactions with the project. @@ -30,8 +31,6 @@ interactions with the project. * 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 -- cgit v1.2.3 From 655d9a9a1b1bd4f797eb2b33a84706a7a271cf1a Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 18 Nov 2020 15:45:14 +0100 Subject: Wording updates Signed-off-by: David Mehren --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21eac494..1dc0854d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ HedgeDoc is a volunteer effort. We encourage you to pitch in and to help us making this project even better! -Please note we have a [code of conduct][code-of-conduct], please follow it in all your +Please note we have a [code of conduct][code-of-conduct], please respect it in all your interactions with the project. ## Ways of contributing @@ -42,7 +42,7 @@ The DCO is a legally binding statement, please [read it carefully](docs/legal/de If you can certify it, then just add a line to every git commit message: ``` - Signed-off-by: Random J Developer + Signed-off-by: Jane Doe ``` Use your real name (sorry, no pseudonyms or anonymous contributions). @@ -54,7 +54,7 @@ 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. + We will try to respond to your issue as soon as possible. 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. -- cgit v1.2.3 From e33a3b5f084cbe8a4b5f6edd7c61514013539c02 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 18 Nov 2020 19:36:35 +0100 Subject: Use chat.hedgedoc.org Signed-off-by: David Mehren --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1dc0854d..06c7cc7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ Now you can commit with `git ci` and the commit will be signed. [code-of-conduct]: ./CODE-OF-CONDUCT.md [community-forum]: https://community.hedgedoc.org -[matrix-support]: https://matrix.to/#/#hedgedoc:matrix.org +[matrix-support]: https://chat.hedgedoc.org [issues]: https://github.com/hedgedoc/hedgedoc/issues [new_issue]: https://github.com/hedgedoc/hedgedoc/issues/new/choose [poeditor]: https://translate.hedgedoc.org -- cgit v1.2.3 From d12d701af45bde7f31011b7b8de392b63da1f54a Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 18 Nov 2020 22:33:25 +0100 Subject: Fix link braces Signed-off-by: David Mehren --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06c7cc7a..f0ce9931 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,13 +9,13 @@ interactions with the project. ## Ways of contributing ### 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]. +* 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). +* **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. +* 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? @@ -29,7 +29,7 @@ interactions with the project. ### 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). +* If you want to improve a translation or add a new translation altogether, we handle those via [POEditor][poeditor]. ## Certificate of Origin -- cgit v1.2.3