diff options
| author |  Stefan Malzner <stefan@adlk.io> | 2017-10-17 00:28:58 +0200 |
|---|---|---|
| committer | Stefan Malzner <stefan@adlk.io> | 2017-10-17 00:28:58 +0200 |
| commit | e2036ddbc886c0c420afd7addf213e55cecb0e94 (patch) | |
| tree | 22d5db3c6057bd7a47002b1d08f458f8d7ff4c8c /CONTRIBUTING.md | |
| parent | Update CI badges to public repository (diff) | |
| download | ferdium-app-e2036ddbc886c0c420afd7addf213e55cecb0e94.tar.gz ferdium-app-e2036ddbc886c0c420afd7addf213e55cecb0e94.tar.zst ferdium-app-e2036ddbc886c0c420afd7addf213e55cecb0e94.zip | |
Add git & javascript styleguide
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65476fa66..b6ae343c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -13,3 +13,14 @@ If you need help with development, want to discuss a new feature or improvement | |||
| 13 | 13 | ||
| 14 | ## How Can I Contribute? | 14 | ## How Can I Contribute? |
| 15 | As a basic rule, before filing issues, feature requests or anything else. Take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion. | 15 | As a basic rule, before filing issues, feature requests or anything else. Take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion. |
| 16 | |||
| 17 | ## Styleguide | ||
| 18 | ### Git Commit Messages | ||
| 19 | * Use the present tense ("Add feature" not "Added feature") | ||
| 20 | * Use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
| 21 | * Limit the first line to 72 characters or less | ||
| 22 | * Reference issues and pull requests liberally after the first line | ||
| 23 | * When only changing documentation, include `[ci skip]` in the commit description | ||
| 24 | |||
| 25 | ### Javascript | ||
| 26 | * Please use `es-lint` and the defined rules to maintain a consistent style | ||