From 041438cb7ffefe9c253cc88d5605556f5f6bbd5a Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Tue, 7 Jul 2026 16:42:03 +0900 Subject: [PATCH 1/3] docs: update readme to reflect current release workflow --- CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++----- 2 files changed, 73 insertions(+), 7 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4e302b8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Introduction + +Thank you for your interest in DZGUI! + +This guide goes over development conventions and best practices for contributors. +If you are a developer, you can skip to the end. + +# Requesting help + +If you encounter a problem with DZGUI, you can submit tickets on the GitHub +(issue tracker)[https://github.com/aclist/dzgui-devel/issues] under the +`troubleshooting` tag. + +# How can I help the project? + +There are several ways to help this project. +1. Report bugs that you find +2. Request features that you would like +3. Contribute features and fixes to the codebase +4. Contribute documentation to the project + +Before making any contribution, please read the `CODE_OF_CONDUCT.md` and act +accordingly. + +## Submitting a ticket + +Navigate to the GitHub (issue tracker)[https://github.com/aclist/dzgui-devel/issues]. +From there, follow the onscreen prompts. You will be asked questions such as: + +- What version are you using? +- What distribution are you using? +- What is the issue that you found? +- How can we reproduce the issue? + +You can also attach screenshots, logs, or other data that can help us. + +## Requesting a feature + +You can also request features via the same issue tracker. It is good practice to +first search for your idea to see if a similar one has already been posted. +If not, open a ticket where you describe your feature and its possible benefits. + +Please note that this is a community project, so it takes time for us to develop +features. Putting in a feature request does not mean that it will be implemented, +but we will do our best to support as many cool ideas as possible. + +## Contributing code or documentation + +If you would like to take ownership or assist with an issue on the issue tracker, or +contribute a new change, please follow the guidelines below. + +Fork this repository and check out the code up to `prerelease/`. +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: +- fix/ - patch/hotfix branches +- feat/ - feature branches +- doc/ - documentation branches +- infra/ - infrastructure branches + +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 +will be merged to `prerelease/`, then `testing`, and after a live +testing phase, to `stable` as well. + +It is recommended to follow +(Conventional Commits)[https://www.conventionalcommits.org/en/v1.0.0/], as this +integrates well with tooling and helps the project review your code. diff --git a/README.md b/README.md index 95f9db0..082dfca 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,8 @@ Please refer to the documentation for installation and setup instructions: Geolocation records from [DB-IP](https://db-ip.com) under [CC 4.0 license](https://creativecommons.org/licenses/by/4.0/) -This tool uses [python-a2s](https://github.com/Yepoleb/python-a2s) and [dayzquery](https://github.com/Yepoleb/dayzquery) as submodules; licenses for these submodules can be found in the LICENSES file -of the project root. - -Both the geolocation records and submodules listed above are not shipped with the source code, but are retrieved and assembled at runtime. - -Finally, executable versions of DZGUI shipped as release binaries are thin wrappers around the Python interpreter, and also retrieve and assemble the above dependencies at runtime on the end-user's -machine, rather than using pre-compiled source code. Users wishing to review these dependencies can inspect the 'pyproject.toml' manifest in the project root. +Executable versions of DZGUI published as release binaries ship with various runtime dependencies and the Python interpreter built in. +Users wishing to review the licenses to these components can inspect the `LICENSE` file located in the release tarball. ## Disclaimer From 9f73c545ef8e1d214a22036caa7da88e83b5f34f Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Tue, 7 Jul 2026 16:42:25 +0900 Subject: [PATCH 2/3] docs: port contributing file from dzgui6, with changes --- CONTRIBUTING.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e302b8..a7e1d1b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,14 +46,10 @@ but we will do our best to support as many cool ideas as possible. ## 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. -Fork this repository and check out the code up to `prerelease/`. -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. +Fork this repository and check out the code up to the `dzgui7` (development) branch. The following naming conventions apply for PRs: - fix/ - patch/hotfix branches @@ -61,11 +57,13 @@ The following naming conventions apply for PRs: - doc/ - documentation branches - infra/ - 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 -will be merged to `prerelease/`, then `testing`, and after a live -testing phase, to `stable` as well. +will be merged to `dzgui7`. After sufficient changes are consolidated into a new release, +this branch will be tagged to a certain point in time and a binary release published. 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. + +Please see DEVELOPERS.md for further details. From 5923d5d935955bf1e513ba8db49535c4ee4869de Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Tue, 7 Jul 2026 16:46:01 +0900 Subject: [PATCH 3/3] fix: typo --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7e1d1b..dad896b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ If you are a developer, you can skip to the end. # Requesting help If you encounter a problem with DZGUI, you can submit tickets on the GitHub -(issue tracker)[https://github.com/aclist/dzgui-devel/issues] under the +(issue tracker)[https://github.com/aclist/dztui/issues] under the `troubleshooting` tag. # How can I help the project? @@ -24,7 +24,7 @@ accordingly. ## Submitting a ticket -Navigate to the GitHub (issue tracker)[https://github.com/aclist/dzgui-devel/issues]. +Navigate to the GitHub (issue tracker)[https://github.com/aclist/dztui/issues]. From there, follow the onscreen prompts. You will be asked questions such as: - What version are you using?