github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 09:16:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/CONTRIBUTING.md
David Mehren b0db43ac15
Introduce changelog snippets 
To make life easier for the release manager,
this introduces changelog snippets to the contribution docs
and the PR template.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-15 20:11:04 +02:00

3.8 KiB
Raw Permalink Blame History

Contributing to HedgeDoc

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, please respect it in all your interactions with the project.

Ways of contributing

Do you have questions about the project?

Did you find a bug?

  • Ensure the bug wasn't already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. 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 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.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). 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.

If you can certify it, then just add a line to every git commit message:

  Signed-off-by: Jane Doe <jane.doe@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 like git config --global alias.ci 'commit -s'. Now you can commit with git ci and the commit will be signed.

Changelog snippets

PRs that fix a bug or add a new feature or enhancement should add a corresponding changelog entry. The changelog can be found at public/docs/release-notes.md. If there is no section for the next release yet, just add one using ## <i class="fa fa-tag"></i> 1.x.x <i class="fa fa-calendar-o"></i> UNRELEASED. The version and date will be filled later by the maintainers.
Add a short description for your change in the Features, Enhancements or Bugfixes section, creating the section if needed. Have a look at previous entries for inspiration. You are welcome to add a (by [@your_username](https://github.com/your_username)) note to your entry.

Submitting a Pull Request

  1. Submit an issue describing your proposed change. 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.