diff options
| author | Aleksi Hietanen <aleksi@vaadin.com> | 2017-11-23 16:13:11 +0200 |
|---|---|---|
| committer | Teemu Suo-Anttila <tsuoanttila@users.noreply.github.com> | 2017-11-23 16:13:11 +0200 |
| commit | 7db9fd366636d3172092c32515e0c3534b455493 (patch) | |
| tree | f8829a7349ec95601f1cafd90f42db4d12151e4d /CONTRIBUTING.md | |
| parent | dbf7da41eb8a311a2c9eb97a42d7dfaa9364b258 (diff) | |
| download | vaadin-framework-7db9fd366636d3172092c32515e0c3534b455493.tar.gz vaadin-framework-7db9fd366636d3172092c32515e0c3534b455493.zip | |
Improve commit message example in CONTRIBUTING.md (#10357)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0baa8d2982..43284b672c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ If you are touching old files and want to update them to current style conventio # Example of a good commit message - Create a Valo icon font for icons used in Valo (#18472) + Create a Valo icon font for icons used in Valo Valo uses only a handful of icons from Font Awesome. This change introduces a separate icon font for valo (9KB instead of 80KB) and decouples Valo from Font Awesome to enable updating Font Awesome without taking Valo into account. @@ -90,11 +90,13 @@ If you are touching old files and want to update them to current style conventio For backwards compatibility, Font Awesome is loaded by default + Closes #123456 + ## Example breakdown -Start with a good Commit message in imperative form. Reference a ticket number if applicable: +Start with a good Commit message in imperative form. - Create a Valo icon font for icons used in Valo (#18472) + Create a Valo icon font for icons used in Valo ### Describe the problem: @@ -108,6 +110,14 @@ Start with a good Commit message in imperative form. Reference a ticket number i For backwards compatibility, Font Awesome is loaded by default +### Reference an Issue: + +If applicable, reference an open issue that your pull request resolves as described in [this article](https://help.github.com/articles/closing-issues-using-keywords/). In the example given above this corresponds to the line + + Closes #123456 + +where `123456` is the hypothetical issue number. + # Include a test Ideally, we would like all patches to include automated tests. Unit tests are preferred. If there’s a change to UI Code, we would prefer a TestBench test. If that’s not possible (you as a contributor lack a TestBench license), we can make do with a Test UI class that contains a test case as well a clear instructions for how to perform the test. This also goes for features that are hard to test automatically. |