Mercurial > template
diff CONTRIBUTE.md @ 27:0706d01e073f
Update markdown convention and add it to STYLE.md
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 25 May 2018 15:49:08 +0200 |
parents | 90a1769a651a |
children | 32a0b02e3c69 |
line wrap: on
line diff
--- a/CONTRIBUTE.md Thu May 24 14:57:32 2018 +0200 +++ b/CONTRIBUTE.md Fri May 25 15:49:08 2018 +0200 @@ -6,9 +6,9 @@ You may submit a patch when: - - You want to fix a bug / typo, - - You want to add a new feature, - - You want to change something. +- You want to fix a bug / typo, +- You want to add a new feature, +- You want to change something. There a lot of steps before submitting a patch. First, be sure to respect the style defined in the STYLE.md file. We never accept patches that do not match @@ -52,10 +52,10 @@ More options are available, see: - - `hg help hgrc.email`, - - `hg help hgrc.smtp`, - - `hg help patchbomb` - - `hg help email` +- `hg help hgrc.email`, +- `hg help hgrc.smtp`, +- `hg help patchbomb` +- `hg help email` ### Note to GMail users @@ -63,9 +63,9 @@ troubles with the `hg email` command, you must create a specific application password. - 1. Go to https://security.google.com/settings/security/apppasswords - 2. Create an application password, it will be auto generated, - 3. Use this password or store it directly in the `smtp.password` option. +1. Go to https://security.google.com/settings/security/apppasswords +2. Create an application password, it will be auto generated, +3. Use this password or store it directly in the `smtp.password` option. Use the following settings: @@ -87,6 +87,21 @@ **Note**: the recommended way is to create one unique revision. +### Commit messages + +Commit messages are written using the following syntax: + + Topic: short message less than 80 characters + + Optional additional description if needed. + +Replace `Topic` with one of the following: + +- **CMake**: for the build system, +- **Docs**: for the documentation, +- **Misc**: for miscellaneous files, +- **Tests**: for the unit tests. + ### Quick way If you plan to create a very small patch that consists of several lines, you can