Skip to content

Commit aac1b42

Browse files
author
Kristan Kenney
committed
Update CONTRIBUTING.md
1 parent 310f6fb commit aac1b42

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,26 @@ We ask that you try to follow existing naming schemes and coding conventions as
2020
### Squashing commits for smaller changes:
2121
When submitting a pull request with multiple smaller commits which are related to the same issue (or file), we ask that you please **squash your commits** in order to keep the project's commit history clean and easy to follow for other developers.
2222

23+
2324
### Working with branches:
24-
Development for this project takes place in branches to effectively develop, manage, and test manage new features and code changes, ensuring that that each release meets high quality standards. There are two main branches which have a never-ending life cycle:
25+
Development for this project takes place in branches to effectively develop, manage, and test manage new features and code changes, ensuring that that each release meets high quality standards. Our primary branches are as follows:
26+
27+
* **master**: Active development code for the the next version of Hestia Control Panel.
28+
* **prerelease**: The next release of Hestia Control Panel which is undergoing testing and quality refinement.
29+
* **release**: The latest stable release code - installation packages generally align with this branch.
30+
31+
We ask that you create a new branch for your work based on **master** or **prerelease**, depending on the code you are contributing. By doing this, you can submit a pull request with only the necessary commits. Please follow the below naming conventions for your work and submit a pull request when it has been completed. Once reviewed and approved, our development team will merge your code into the primary development branch.
2532

26-
* **master**:Latest stable release code (install packages align with this branch)
27-
* **develop**: Primary development branch containing code for the next release.
33+
* **feature/area/name-of-feature**: New features
34+
* **hotfix/000**: Critical security or bug fixes
35+
* **bugfix/000**: Non-critical bug fixes
2836

29-
If you are submitting a fix for a critical issue (such as security or broken functionality) in the current release, please create a branch with the prefix **hotfix-** starting from **master** for your work and submit a pull request with **[CRITICAL]** in the title.
37+
**Note**: Replace **area** with Web, DNS, Mail, etc. Replace **000** with the GitHub Issue ID if available, or use a short but descriptive name.
3038

31-
For all other changes, we ask that you create a new branch based on **develop**. Please follow the below naming conventions for your work and submit a pull request when it has been completed. Once reviewed and approved, our development team will merge your code into the primary development branch.
39+
### Feature freeze:
40+
The general flow of our development process is that new features or work begin in a new branch derived from **master**. Once the work has been completed and reviewed, it is then submitted via Pull Request for further review and inclusion into the main code base. Once a release has reached a point where slated new features have been incorporated and the build has gone through testing and validation, it will then enter a "feature freeze" state where only fixes to the existing functionality will be merged for inclusion and be pushed to the **prerelease** branch. Once any remaining known issues have been resolved and the build is considered stable, the code is then pushed to **release** and the cycle starts all over again.
3241

33-
* **feature-**: New features
34-
* **bugfix-**: Fixes for non-critical bugs
35-
* **secfix-**: Fixes for non-critical security issues
36-
* **webui-**: Control Panel user experience and interface changes
42+
**master** -> **prerelease** -> **release**
3743

3844
**Please ensure that all pull requests meet the guidelines listed above; those that do not will be rejected and sent back for review.**
3945

0 commit comments

Comments
 (0)