You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A clear and concise description of what the bug is. Please include as much information as possible in your issue report, such as the configuration of your server and any troubleshooting steps that you've already performed.
12
+
13
+
**NOTE: Do not include any personal or sensitive information, such as email addresses or passwords.**
14
+
15
+
**To Reproduce**
16
+
What steps did you take when the issue occured?
17
+
1. Ex.: Click on the "Web" tab.
18
+
2. Ex.: Click on "Add Web Domain".
19
+
3. Ex.: Attempted to add a domain and received an Internal Server Error.
20
+
21
+
**Expected behavior**
22
+
A clear and concise description of what you expected to happen.
23
+
24
+
**Screenshots**
25
+
If applicable, add screenshots to help explain your problem.
26
+
27
+
**Operating system:**
28
+
Please enter your answer here (e.g. Ubuntu 20.04 LTS)
29
+
30
+
**Hestia Control Panel version:**
31
+
Please enter your answer here (e.g. 1.3.2).
32
+
33
+
**Additional context**
34
+
If there is anything else that you'd like us to know about this issue that will help us diagnose and troubleshoot more effectively, such as links to forum posts or other discussions, please feel free to share here.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-59Lines changed: 19 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ Hestia Control Panel - Contribution Guidelines
4
4
Ways to contribute
5
5
-----------------------
6
6
-**Beta testing**:
7
-
- Download and install builds from the `beta` branch. Provide feedback to our developers and file any issues that you come across on [GitHub](https://www.github.com/hestiacp/hestiacp/issues).<br>
7
+
- Download and install builds from the `beta` branch. If you encounter an issue with a beta build, file an issue report on [GitHub](https://www.github.com/hestiacp/hestiacp/issues).<br>
8
8
`v-update-sys-hestia-git hestiacp beta install` will install the latest beta build from our GitHub repository.
9
9
-**Code review and bug fixes**:
10
-
- Read over the code and if you notice errors (even spelling mistakes), submit a pull request with your fixes.
10
+
- Read over the code and if you notice errors (even spelling mistakes), submit a pull request with your changes.
11
11
-**New features**:
12
-
- Is there an awesome feature that you'd love to see included? While our development team tries to fulfill all reasonable requests, it can take time to implement new features depending on the amount of work involved. Submit a pull request with your code and if your idea is approved, we'll review and test it for inclusion with an upcoming release.
12
+
- Is there an awesome feature that you'd love to see included? Submit a pull request with your changes, and if approved your PR will be reviewed and merged for inclusion in an upcoming release. While our development team tries to accomodate all reasonable requests please remember that it does take time to develop, implement and test new features and as such we may not be able to fulfill all requests or may have to put a feature on backlog for a later date.
13
13
-**Translations**:
14
-
- If you are a non-English speaker and would like to improve the quality of the translations used in Hestia Control Panel's web interface, Please go to [Hestia Translate](https://translate.hestiacp.com/projects/hestiacp/) to review the translations. For more information please read [How to contribute with Translations](https://forum.hestiacp.com/t/how-to-contribute-with-translations/1664). Or open an issue report [GitHub](https://www.github.com/hestiacp/hestiacp/issues) highlighting the issue with the current translation so that it can be corrected.
14
+
- If you are a non-English speaker and would like to improve the quality of the translations used in Hestia Control Panel's web interface, please go to [Hestia Translate](https://translate.hestiacp.com/projects/hestiacp/) to review the translations database. For more information please read [How to contribute with Translations](https://forum.hestiacp.com/t/how-to-contribute-with-translations/1664) on our forum. You can also open an issue report [GitHub](https://www.github.com/hestiacp/hestiacp/issues) highlighting the issue with the current translation so that it can be corrected.
15
15
-**Donations**:
16
-
- If you're not a developer but you still want to make a contribution, you can make a donation to the Hestia Control Panel project to further its development (or if you'd just like to buy our developers a lunch, we'd appreciate that too). We currently accept donations through [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA).
16
+
- If you're not a developer but you still want to make a contribution to support Hestia Control Panel and our developers, you can make a donation to the Hestia Control Panel project to further its development (or if you'd just like to buy our developers a lunch, we'd appreciate that too). We currently accept donations through [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA).
17
17
18
18
Development Guidelines
19
19
-----------------------
@@ -25,28 +25,27 @@ Development for this project takes place in branches to effectively develop, man
25
25
26
26
We have three primary or "evergreen" branches, which exist throughout our product's lifetime. Please refer to the following table for a description:
|`main`| Contains a snapshot of the latest development code.<br>**Not intended for production use and contains code from a merge snapshot.**| Daily |
31
-
|`beta`| Contains a snapshot of the next version which is currently in testing.<br>**Not intended for production but should be highly stable.**| Weekly |
32
-
|`release`| Contains a snapshot of the latest stable release.<br>**Intended for production use. This repository contains the same code as our compiled packages.**| Monthly |
28
+
| Branch | Description
29
+
|---------------|:---------------:|
30
+
| `main` | Contains a snapshot of the latest development code.<br>**Not intended for production use and contains code from a merge snapshot.**
31
+
| `beta` | Contains a snapshot of the next version which is currently in testing.<br>**Not intended for production use, however code from this branch should be stable.**
32
+
| `release` | Contains a snapshot of the latest stable release.<br>**Intended for production use. This repository contains the same code as our compiled packages.**
33
33
34
34
### Creating a new branch and submitting pull requests
35
-
The first step is to create a fork of the `hestiacp/hestiacp` repository under your account so that you may submit pull requests and patches via GitHub.
35
+
The first step is to create a fork of the `hestiacp/hestiacp` repository under your GitHub account so that you may submit pull requests and patches.
36
36
37
-
Once you've created your fork, clone the repository to your computer and make sure that you've checked out the `main` branch. **Always** create a new topic branch for you work. When submitting pull requests it is important that you target the correct branch to ensure that your changes are properly integrated and tested based on our release schedule. When creating a new branch, we ask that you please adhere to the following naming conventions as much as possible:
37
+
Once you've created your fork, clone the repository to your computer and make sure that you've checked out the `main` branch. **Always** create a new topic branch for your work.
38
38
39
39
### Branch naming convention:
40
40
-**Prefix:**`topic/` (such as **fix**, **feature**, **refactor**, etc.)
41
-
-**ID**: `888` (GitHub Issue ID if an issue exists) -or- `2020-07` (Year-Month if an issue does not already exist)
42
-
-**Separator:**`_` (underscore)
41
+
-**ID**: `888` (GitHub Issue ID if an issue exists)
43
42
-**Title:**`my-awesome-patch`
44
43
45
44
Branch name examples:
46
-
*`feature/777_my-awesome-new-feature` or `feature/2020-07_my-other-new-feature`
47
-
*`fix/000_some-bug-fix` or `fix/2020-07_this-feature-is-broken`
48
-
*`refactor/2020-07_v-change-domain-owner`
49
-
*`test/2020-07_mail-domain-ssl`
45
+
*`feature/777-my-awesome-new-feature` or `feature/my-other-new-feature`
46
+
*`fix/000-some-bug-fix` or `fix/this-feature-is-broken`
47
+
*`refactor/v-change-domain-owner`
48
+
*`test/mail-domain-ssl`
50
49
51
50
### Squashing commits for smaller changes
52
51
To aid other developers and keep the project's commit history clean, please **squash your commits** when it's appropriate. For example with smaller commits related to the same piece of code, such as commits labelled "Fixed item 1", "Adjusted color of button XYZ", "Adjusted alignment of button XYZ" can be squashed into one commit with the title "Fixed button issues in item".
@@ -55,48 +54,9 @@ To aid other developers and keep the project's commit history clean, please **sq
55
54
- Our internal development team will review your work and validate your request.
56
55
- Your changes will be tested to ensure that there are no issues.
57
56
- If changes need to be made, you will be notified via GitHub.
58
-
- Once approved, your code will be merged to the appropriate `staging/*` branch based on the chart below:
59
-
60
-
All pull requests must include a brief but descriptive title, and a description of the changes that you've made with as much detail as possible. **Only include commits that are related to your feature, bug fix, or patch in your pull request.**
61
-
62
-
| Topic branches: | Primary Target: | Final destination: |
-`topic/*` branches are submitted to our team via a pull request. Your changes will be reviewed and tested, and if all appropriate quality assurance checks pass the branch will be merged to the corresponding `staging/*` branch.
74
-
75
-
-`staging/*` branches merge into `main` at various intervals throughout the development process.
76
-
77
-
- When all planned features and fixes have been merged to `main`, the code is tested for regressions and bugs.
78
-
79
-
- A snapshot of `main` is pushed to a temporary branch called `staging/refactoring`, and final code review, refactoring, and optimization takes place. Once complete, `staging/refactoring` merges back to `main` bringing the codebase up-to-date. All other `staging/*` branches synchronize with `main` at this time.
80
-
81
-
- After final validation checks pass, our development team signs off on the release and the code is pushed from `main` to `beta`.
82
-
83
-
### During the release cycle:
84
-
-**What happens when code moves from `main` to `beta`**:<br>
85
-
-**No new feature requests will be approved**.
86
-
-`main` will receive an increment in it's version number signaling the start of a new development cycle.
87
-
-`fix/*` topic branches/commits will be cherry picked to `beta` as necessary.
88
-
-`staging/docs` will merge into `beta` prior to the code being pushed to `release` to bring documentation and supporting files up-to-date.
89
-
90
-
- If all quality assurance checks pass, our development team will then:
91
-
- Sign off on the code in `beta`.
92
-
- Push the code to the `release` branch and create a corresponding version tag.
93
-
- Compile new packages and publish them to our APT repository.
94
-
-**Notes:**
95
-
-`release` always contains the highest released version of Hestia Control Panel.
96
-
- For major releases, a `release/vX.x` branch will be created for maintenance and servicing purposes.
97
-
98
-
57
+
- Once approved, your code will be merged for inclusion in an upcoming release of Hestia Control Panel.
99
58
59
+
All pull requests must include a brief but descriptive title, and a detailed description of the changes that you've made. **Only include commits that are related to your feature, bug fix, or patch in your pull request!**
0 commit comments