|
1 | | -# Contributing |
2 | | - |
3 | | -Looking to contribute to ATLauncher? Excellent, we welcome any and all contributions. |
4 | | - |
5 | | -When contributing to this repository, please first discuss the change you wish to make via GitHub issue, |
6 | | -[Discord](https://atl.pw/discord), or any other method with the owners of this repository before making a change. |
7 | | - |
8 | | -## Code of Conduct |
9 | | - |
10 | | -Please note we have a code of conduct, please follow it in all your interactions with the project. |
11 | | - |
12 | | -## Reporting an Issue |
13 | | - |
14 | | -If you have an issue with any product/service of ATLauncher, please create an issue in the appropriate GitHub |
15 | | -repository. |
16 | | - |
17 | | -If there is no appropriate repository for your issue, please speak to any ATLauncher Staff member on our |
18 | | -[Discord](https://atl.pw/discord). |
19 | | - |
20 | | -Alternatively you may email support@atlauncher.com with your issue. |
21 | | - |
22 | | -If you have a security issue to disclose, please send an email to security@atlauncher.com so we can ensure that it's |
23 | | -looked after in a timely and sensitive manner. |
24 | | - |
25 | | -## Pull Request's |
26 | | - |
27 | | -* Ensure the [Pull Request Template](PULL_REQUEST_TEMPLATE.md) is filled out |
28 | | -* Ensure that your commit history is clean, lean and follows our [Branching Structure](#branching-structure) |
29 | | -* Include screenshots and animated GIFs in your Pull Request when possible |
30 | | -* Follow our [styling best practices](#styling-best-practices) for all code and documentation |
31 | | - |
32 | | -## Branching Structure |
33 | | - |
34 | | -Our branching structure is based on |
35 | | -[Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). |
36 | | - |
37 | | -* **master** will always contain the code for the latest production release |
38 | | -* **develop** will contain the latest beta version used for testing |
39 | | -* **feature/*** will contain single issues being developed. Once developed they're merged into develop and tagged with |
40 | | - a beta release version. They should be named 'feature/22-some-brief-description' |
41 | | -* **release/*** will contain all the code from each feature branch that are going out in the next release and should |
42 | | - all be merged into the branch. Once approved and tested it gets merged into master and tagged. They should be named |
43 | | - 'release/4.1.1' |
44 | | -* **hotfix/*** will contain hotfixes going to be merged directly into master then tagged. Hotfixes should only need to |
45 | | - occur when there is a very critical bug in the current release that needs to be fixed ASAP. All hotfix branches should |
46 | | - be branched off of master |
47 | | - |
48 | | -All tags are done on the **master** branch only and should be in format **v(version number)**. Most versioning and |
49 | | -tagging is done automatically, so please check before doing so manually. |
50 | | - |
51 | | -All develop releases should be versioned as **beta** versions. For instance **4.1.1-beta.15**. |
52 | | - |
53 | | -Feature branches are deleted once in a release branch. Any issues that come up after the features branch has been merged |
54 | | -nto a release branch should be resolved by creating a new feature branch off the release branch. |
55 | | - |
56 | | -An example of a good name for a feature branch is say there is an issue (#44) which is about not being able to delete a |
57 | | -pack. A good name for a feature branch would be `feature/44-unable-to-delete-packs` and go from there. |
58 | | - |
59 | | -## Styling Best Practices |
60 | | - |
61 | | -When committing code or documentation, please ensure that you follow our set out |
62 | | -[style guide](https://github.com/ATLauncher/style-guide). |
63 | | - |
64 | | -## Issue and Pull Request Labels |
65 | | - |
66 | | -This section lists the labels we use to help us track and manage issues and pull requests. While some labels are not |
67 | | -available in older repositories, most public repositories will use these conventions for labels. |
68 | | - |
69 | | -[GitHub search](https://help.github.com/articles/searching-issues/) makes it easy to use labels for finding groups of |
70 | | -issues or pull requests you're interested in. |
71 | | - |
72 | | -### Issue Labels |
73 | | - |
74 | | -| Label name | Description | |
75 | | -| --- | --- | |
76 | | -| `enhancement` | Feature requests. | |
77 | | -| `bug` | Confirmed bugs or reports that are very likely to be bugs. | |
78 | | -| `question` | Questions more than bug reports or feature requests (e.g. how do I do X). | |
79 | | -| `feedback` | General feedback more than bug reports or feature requests. | |
80 | | -| `help-wanted` | The ATLauncher team would appreciate help from the community in resolving these issues. | |
81 | | -| `beginner` | Less complex issues which would be good first issues to work on for users who want to contribute. | |
82 | | -| `more-information-needed` | More information needs to be collected about these problems or feature requests | |
83 | | -| `needs-reproduction` | Likely bugs, but haven't been reliably reproduced. | |
84 | | -| `triage-help-needed` | Help is needed to triage the issue. | |
85 | | -| `blocked` | Issues blocked on other issues. | |
86 | | -| `duplicate` | Issues which are duplicates of other issues, i.e. they have been reported before. | |
87 | | -| `wontfix` | The ATLauncher team has decided not to fix these issues for now for some reason. | |
88 | | -| `invalid` | Issues which aren't valid (e.g. user errors). | |
89 | | -| `wrong-repo` | Issues reported on the wrong repository. | |
90 | | - |
91 | | -### Pull Request Labels |
92 | | - |
93 | | -| Label name | Description |
94 | | -| --- | --- | |
95 | | -| `work-in-progress` | Pull requests which are still being worked on, more changes will follow. | |
96 | | -| `needs-review` | Pull requests which need code review, and approval from maintainers or ATLauncher team. | |
97 | | -| `under-review` | Pull requests being reviewed by maintainers or ATLauncher team. | |
98 | | -| `requires-changes` | Pull requests which need to be updated based on review comments and then reviewed again. | |
99 | | -| `needs-testing` | Pull requests which need manual testing. | |
100 | | -| `ready-to-merge` | Pull requests which have been reviewed and are ready to merge. | |
| 1 | +# Contributing |
| 2 | + |
| 3 | +Looking to contribute to ATLauncher? Excellent, we welcome any and all contributions. |
| 4 | + |
| 5 | +When contributing to this repository, please first discuss the change you wish to make via GitHub issue, |
| 6 | +[Discord](https://atl.pw/discord), or any other method with the owners of this repository before making a change. |
| 7 | + |
| 8 | +## Code of Conduct |
| 9 | + |
| 10 | +Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 11 | + |
| 12 | +## Reporting an Issue |
| 13 | + |
| 14 | +If you have an issue with any product/service of ATLauncher, please create an issue in the appropriate GitHub |
| 15 | +repository. |
| 16 | + |
| 17 | +If there is no appropriate repository for your issue, please speak to any ATLauncher Staff member on our |
| 18 | +[Discord](https://atl.pw/discord). |
| 19 | + |
| 20 | +Alternatively you may email support@atlauncher.com with your issue. |
| 21 | + |
| 22 | +If you have a security issue to disclose, please send an email to security@atlauncher.com so we can ensure that it's |
| 23 | +looked after in a timely and sensitive manner. |
| 24 | + |
| 25 | +## Pull Request's |
| 26 | + |
| 27 | +* Ensure the [Pull Request Template](PULL_REQUEST_TEMPLATE.md) is filled out |
| 28 | +* Ensure that your commit history is clean, lean and follows our [Branching Structure](#branching-structure) |
| 29 | +* Include screenshots and animated GIFs in your Pull Request when possible |
| 30 | +* Follow our [styling best practices](#styling-best-practices) for all code and documentation |
| 31 | + |
| 32 | +## Branching Structure |
| 33 | + |
| 34 | +Our branching structure is based on |
| 35 | +[Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). |
| 36 | + |
| 37 | +* **master** will always contain the code for the latest production release |
| 38 | +* **develop** will contain the latest beta version used for testing |
| 39 | +* **feature/*** will contain single issues being developed. Once developed they're merged into develop and tagged with |
| 40 | + a beta release version. They should be named 'feature/22-some-brief-description' |
| 41 | +* **release/*** will contain all the code from each feature branch that are going out in the next release and should |
| 42 | + all be merged into the branch. Once approved and tested it gets merged into master and tagged. They should be named |
| 43 | + 'release/4.1.1' |
| 44 | +* **hotfix/*** will contain hotfixes going to be merged directly into master then tagged. Hotfixes should only need to |
| 45 | + occur when there is a very critical bug in the current release that needs to be fixed ASAP. All hotfix branches should |
| 46 | + be branched off of master |
| 47 | + |
| 48 | +All tags are done on the **master** branch only and should be in format **v(version number)**. Most versioning and |
| 49 | +tagging is done automatically, so please check before doing so manually. |
| 50 | + |
| 51 | +All develop releases should be versioned as **beta** versions. For instance **4.1.1-beta.15**. |
| 52 | + |
| 53 | +Feature branches are deleted once in a release branch. Any issues that come up after the features branch has been merged |
| 54 | +nto a release branch should be resolved by creating a new feature branch off the release branch. |
| 55 | + |
| 56 | +An example of a good name for a feature branch is say there is an issue (#44) which is about not being able to delete a |
| 57 | +pack. A good name for a feature branch would be `feature/44-unable-to-delete-packs` and go from there. |
| 58 | + |
| 59 | +## Styling Best Practices |
| 60 | + |
| 61 | +When committing code or documentation, please ensure that you follow our set out |
| 62 | +[style guide](https://github.com/ATLauncher/style-guide). |
| 63 | + |
| 64 | +## Issue and Pull Request Labels |
| 65 | + |
| 66 | +This section lists the labels we use to help us track and manage issues and pull requests. While some labels are not |
| 67 | +available in older repositories, most public repositories will use these conventions for labels. |
| 68 | + |
| 69 | +[GitHub search](https://help.github.com/articles/searching-issues/) makes it easy to use labels for finding groups of |
| 70 | +issues or pull requests you're interested in. |
| 71 | + |
| 72 | +### Issue Labels |
| 73 | + |
| 74 | +| Label name | Description | |
| 75 | +| --- | --- | |
| 76 | +| `enhancement` | Feature requests. | |
| 77 | +| `bug` | Confirmed bugs or reports that are very likely to be bugs. | |
| 78 | +| `question` | Questions more than bug reports or feature requests (e.g. how do I do X). | |
| 79 | +| `feedback` | General feedback more than bug reports or feature requests. | |
| 80 | +| `help-wanted` | The ATLauncher team would appreciate help from the community in resolving these issues. | |
| 81 | +| `beginner` | Less complex issues which would be good first issues to work on for users who want to contribute. | |
| 82 | +| `more-information-needed` | More information needs to be collected about these problems or feature requests | |
| 83 | +| `needs-reproduction` | Likely bugs, but haven't been reliably reproduced. | |
| 84 | +| `triage-help-needed` | Help is needed to triage the issue. | |
| 85 | +| `blocked` | Issues blocked on other issues. | |
| 86 | +| `duplicate` | Issues which are duplicates of other issues, i.e. they have been reported before. | |
| 87 | +| `wontfix` | The ATLauncher team has decided not to fix these issues for now for some reason. | |
| 88 | +| `invalid` | Issues which aren't valid (e.g. user errors). | |
| 89 | +| `wrong-repo` | Issues reported on the wrong repository. | |
| 90 | + |
| 91 | +### Pull Request Labels |
| 92 | + |
| 93 | +| Label name | Description |
| 94 | +| --- | --- | |
| 95 | +| `work-in-progress` | Pull requests which are still being worked on, more changes will follow. | |
| 96 | +| `needs-review` | Pull requests which need code review, and approval from maintainers or ATLauncher team. | |
| 97 | +| `under-review` | Pull requests being reviewed by maintainers or ATLauncher team. | |
| 98 | +| `requires-changes` | Pull requests which need to be updated based on review comments and then reviewed again. | |
| 99 | +| `needs-testing` | Pull requests which need manual testing. | |
| 100 | +| `ready-to-merge` | Pull requests which have been reviewed and are ready to merge. | |
0 commit comments