|
1 | | -Note: This is still a work in progress. Some parts of this file are not finalized and are kept outside of the project. |
| 1 | +It's recommended to read the Documentation if you wish to contribute to Flashpoint Launcher development. |
2 | 2 |
|
3 | | -# Branch naming guidelines and Pull Requests |
| 3 | +You'll likely find help in the #launcher channel of the discord as well. |
4 | 4 |
|
5 | | -Branches are expected to follow the git flow naming scheme: |
6 | | -- `feature/<name>` |
7 | | -- `bugfix/<name>` |
8 | | -- `hotfix/<name>` |
| 5 | +Documentation: https://flashpointproject.github.io/launcher |
9 | 6 |
|
10 | | -Make sure that the base for PRs is set to ``develop`` for features and ``master`` or ``develop`` for hotfixes or bugfixes. |
11 | | - |
12 | | -Maintainer Note - Make sure to merge hotfixes and bugfixes manually with `--no-ff` into both master and develop. See https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow for more detail. |
13 | | - |
14 | | -# Commit Message Guidelines |
15 | | - |
16 | | -*Note: These guidelines are based on the [guidelines used by Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md)* |
17 | | - |
18 | | -Each commit message consists of a header, a body and a footer. The header has a special format that includes a type and a subject: |
19 | | - |
20 | | -``` |
21 | | -<type>: <subject> |
22 | | -<BLANK LINE> |
23 | | -<body> |
24 | | -<BLANK LINE> |
25 | | -<footer> |
26 | | -``` |
27 | | - |
28 | | -The **header** is mandatory. The **body** is optional. The **footer** is temporarily forbidden. |
29 | | - |
30 | | -The **subject**, **body** and **footer** may be split over any number of lines, but they must not contain any blank lines (in order to make it clear where each section begin and end). |
31 | | - |
32 | | -Any line of the commit message MUST NOT be longer than 73 characters! |
33 | | - |
34 | | -## Type |
35 | | - |
36 | | -Must be one of the following: |
37 | | - |
38 | | -* **build**: Changes that affect the build system or external dependencies (for example: editing ``package.json``, ``gulpfile.js`` or ``.eslintrc.json``) |
39 | | -* **docs**: Documentation only changes |
40 | | -* **feat**: A new feature |
41 | | -* **fix**: A bug fix |
42 | | -* **github**: Changes to our GitHub CI configuration files or scripts |
43 | | -* **perf**: A code change that improves performance |
44 | | -* **refactor**: A code change that neither fixes a bug nor adds a feature |
45 | | -* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.) |
46 | | -* **test**: Adding missing tests or correcting existing tests |
47 | | - |
48 | | -## Body |
49 | | - |
50 | | -Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. |
51 | | - |
52 | | -## Footer |
53 | | - |
54 | | -The footer is **RESERVED** and must not be included in any commit. |
| 7 | +Discord: https://discordapp.com/invite/qhvAkhWXU5 |
0 commit comments