mirror of
https://github.com/aclist/dztui.git
synced 2026-10-30 14:42:54 +01:00
docs: port contributing file from dzgui6, with changes
This commit is contained in:
1 parent
041438cb7f
commit
9f73c545ef
1 file changed
+8
-10
+8
-10
@@ -46,14 +46,10 @@ but we will do our best to support as many cool ideas as possible.
|
|||||||
|
|
||||||
## Contributing code or documentation
|
## Contributing code or documentation
|
||||||
|
|
||||||
If you would like to take ownership or assist with an issue on the issue tracker, or
|
If you would like to assist with an issue on the issue tracker or
|
||||||
contribute a new change, please follow the guidelines below.
|
contribute a new change, please follow the guidelines below.
|
||||||
|
|
||||||
Fork this repository and check out the code up to `prerelease/<latest-version>`.
|
Fork this repository and check out the code up to the `dzgui7` (development) branch.
|
||||||
If there is no pending prerelease PR, you can base your changes off of
|
|
||||||
the `testing` branch. You may later be asked to retarget your PR to the prerelease
|
|
||||||
branch once a new one is made. This is because out-of-band PRs are consolidated into
|
|
||||||
the next release before merging.
|
|
||||||
|
|
||||||
The following naming conventions apply for PRs:
|
The following naming conventions apply for PRs:
|
||||||
- fix/<your-fix> - patch/hotfix branches
|
- fix/<your-fix> - patch/hotfix branches
|
||||||
@@ -61,11 +57,13 @@ The following naming conventions apply for PRs:
|
|||||||
- doc/<your-doc-branch> - documentation branches
|
- doc/<your-doc-branch> - documentation branches
|
||||||
- infra/<your-infra-branch> - infrastructure branches
|
- infra/<your-infra-branch> - infrastructure branches
|
||||||
|
|
||||||
Implement your changes and test them locally. If they work you may
|
Implement your changes and test them locally. If they work, you may
|
||||||
open a merge request, and then we review your changes. If everything is OK, it
|
open a merge request, and then we review your changes. If everything is OK, it
|
||||||
will be merged to `prerelease/<latest-version>`, then `testing`, and after a live
|
will be merged to `dzgui7`. After sufficient changes are consolidated into a new release,
|
||||||
testing phase, to `stable` as well.
|
this branch will be tagged to a certain point in time and a binary release published.
|
||||||
|
|
||||||
It is recommended to follow
|
It is recommended to follow
|
||||||
(Conventional Commits)[https://www.conventionalcommits.org/en/v1.0.0/], as this
|
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), as this
|
||||||
integrates well with tooling and helps the project review your code.
|
integrates well with tooling and helps the project review your code.
|
||||||
|
|
||||||
|
Please see DEVELOPERS.md for further details.
|
||||||
Reference in new issue
Block a user