diff options
Diffstat (limited to 'docs/CONTRIBUTE.md')
| -rw-r--r-- | docs/CONTRIBUTE.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md index 978b87d27..3d4bf49e0 100644 --- a/docs/CONTRIBUTE.md +++ b/docs/CONTRIBUTE.md @@ -108,7 +108,7 @@ submit a small description of your fix or your new features with every contribution so that it can be swiftly added to the package documentation. The documentation is always made in man pages (nroff formatted) or plain -ASCII files. All HTML files on the web site and in the release archives are +ASCII files. All HTML files on the website and in the release archives are generated from the nroff/ASCII versions. ### Test Cases @@ -200,6 +200,16 @@ A short guide to how to write commit messages in the curl project. [whatever-else-by: credit all helpers, finders, doers] ---- stop ---- +The first line is a succinct description of the change: + + - use the imperative, present tense: "change" not "changed" nor "changes" + - don't capitalize first letter + - no dot (.) at the end + +The `[area]` in the first line can be `http2`, `cookies`, `openssl` or +similar. There's no fixed list to select from but using the same "area" as +other related changes could make sense. + Don't forget to use commit --author="" if you commit someone else's work, and make sure that you have your own user and email setup correctly in git before you commit @@ -265,3 +275,6 @@ For Windows: - [https://gnuwin32.sourceforge.io/packages/patch.htm](https://gnuwin32.sourceforge.io/packages/patch.htm) - [https://gnuwin32.sourceforge.io/packages/diffutils.htm](https://gnuwin32.sourceforge.io/packages/diffutils.htm) + +### Useful resources +* [Webinar on getting code into cURL](https://www.youtube.com/watch?v=QmZ3W1d6LQI) |