From c883fc586c14e10f76a610d632645ad3cf6a337b Mon Sep 17 00:00:00 2001 From: Gergely Koloszar Date: Fri, 24 Oct 2025 13:43:26 +0000 Subject: [PATCH 1/6] doc: add contributing.md --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..941e7e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Introduction + +Thank you for considering contributing to DZGUI! + +This is a guide for contributors containing conventions best practices and rules +of development and aims to ease the beginning of a contribution. + +# 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 + +## How to report + +Reproduce the bug that you found. Navigate to the issue tracker on github: +(link)[https://github.com/aclist/dzgui-devel/issues] +Create a ticket where you give us the following: +- What version are you using? +- What distribution are you using? +- What is the issue that you found? +- How can we reproduce the issue? +- Possible screenshots, logs, other data that can help us + +## How to request a feature + +Navigate to the projects issue tracker +(link)[https://github.com/aclist/dzgui-devel/issues]. Search for your idea to +see if anyone had posted a simmilar idea. If not, open a ticket where you +describe your feature and its possible benefits. Please note, that this is a +community project, it takes time for us to develop features, having a feature +request doesn't mean that it will be implemented, but we do our best to support +as many cool ideas as possible. + +## How to contribute code or documentation + +If you have an issue of interest in the issue tracker or any other change that +you would like to have implemented you can contribute code to this project. For +this, you may fork this repository and checkout to `testing`. All new features +and fixes will be merged to this branch, so open your branch from here. Name it +according to our convention: +- fix/ - fix branches +- feat/ - feature branches +- doc/ - documentation branches +- infra/ - infrastructure branches + +Now you can implement your changes and test it 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 `testing` and after a live testing phase, to `master` as well. + +During development, it is recommended to follow (conventional +commits)[https://www.conventionalcommits.org/en/v1.0.0/], it helps the project +maintainers when they review your code. From 16d8f567a462673aacc5983fc1c018a7d2cf37c7 Mon Sep 17 00:00:00 2001 From: Gergely Koloszar Date: Fri, 24 Oct 2025 14:00:46 +0000 Subject: [PATCH 2/6] doc: add code of conduct notice --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 941e7e5..da8ad3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,9 @@ There are several ways to help this project. 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. + ## How to report Reproduce the bug that you found. Navigate to the issue tracker on github: From 957ad47b4ddb324e07f5e6665526483349c2e5a3 Mon Sep 17 00:00:00 2001 From: Gergely Koloszar Date: Fri, 24 Oct 2025 14:01:00 +0000 Subject: [PATCH 3/6] doc: add troubleshooting help to contribute.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da8ad3c..937d187 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,13 @@ Thank you for considering contributing to DZGUI! This is a guide for contributors containing conventions best practices and rules of development and aims to ease the beginning of a contribution. +# How can I request help? + +There is an issue tracker on github +(link)[https://github.com/aclist/dzgui-devel/issues] where you can submit +tickets. If you need help troubleshooting a problem, submit a ticket. There is a +category called `troubleshooting` which is exactly what you need. + # How can I help the project? There are several ways to help this project. From dccdffe7617c538230c03c51b19678c6c3879b2a Mon Sep 17 00:00:00 2001 From: Gergely Koloszar Date: Fri, 24 Oct 2025 14:04:37 +0000 Subject: [PATCH 4/6] doc: change branch names to currently used ones --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 937d187..25eabbb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,9 +48,9 @@ as many cool ideas as possible. If you have an issue of interest in the issue tracker or any other change that you would like to have implemented you can contribute code to this project. For -this, you may fork this repository and checkout to `testing`. All new features -and fixes will be merged to this branch, so open your branch from here. Name it -according to our convention: +this, you may fork this repository and checkout to +`prerelease/`. All new features and fixes will be merged to this +branch, so open your branch from here. Name it according to our convention: - fix/ - fix branches - feat/ - feature branches - doc/ - documentation branches @@ -58,7 +58,8 @@ according to our convention: Now you can implement your changes and test it 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 `testing` and after a live testing phase, to `master` as well. +will be merged to `prerelease/`, then `testing` and after a live +testing phase, to `stable` as well. During development, it is recommended to follow (conventional commits)[https://www.conventionalcommits.org/en/v1.0.0/], it helps the project From 506c82e86a685c9e0670df69a547ef7bef467991 Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Sat, 25 Oct 2025 11:51:19 +0900 Subject: [PATCH 5/6] chore: reword CONTRIBUTING.md Corrected some typos and reworded passive voice/some sections for brevity. --- CONTRIBUTING.md | 67 ++++++++++++++++++++++++++----------------------- 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25eabbb..791f660 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,15 @@ # Introduction -Thank you for considering contributing to DZGUI! +Thank you for your interest in DZGUI! -This is a guide for contributors containing conventions best practices and rules -of development and aims to ease the beginning of a contribution. +This guide goes over development conventions and best practices for contributors. +If you are a developer, you can skip to the end. -# How can I request help? +# Requesting help -There is an issue tracker on github -(link)[https://github.com/aclist/dzgui-devel/issues] where you can submit -tickets. If you need help troubleshooting a problem, submit a ticket. There is a -category called `troubleshooting` which is exactly what you need. +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? @@ -23,44 +22,48 @@ There are several ways to help this project. Before making any contribution, please read the `CODE_OF_CONDUCT.md` and act accordingly. -## How to report +## 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: -Reproduce the bug that you found. Navigate to the issue tracker on github: -(link)[https://github.com/aclist/dzgui-devel/issues] -Create a ticket where you give us the following: - What version are you using? - What distribution are you using? - What is the issue that you found? - How can we reproduce the issue? -- Possible screenshots, logs, other data that can help us -## How to request a feature +You can also attach screenshots, logs, or other data that can help us. -Navigate to the projects issue tracker -(link)[https://github.com/aclist/dzgui-devel/issues]. Search for your idea to -see if anyone had posted a simmilar idea. If not, open a ticket where you -describe your feature and its possible benefits. Please note, that this is a -community project, it takes time for us to develop features, having a feature -request doesn't mean that it will be implemented, but we do our best to support -as many cool ideas as possible. +## Requesting a feature -## How to contribute code or documentation +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. -If you have an issue of interest in the issue tracker or any other change that -you would like to have implemented you can contribute code to this project. For -this, you may fork this repository and checkout to -`prerelease/`. All new features and fixes will be merged to this -branch, so open your branch from here. Name it according to our convention: -- fix/ - fix branches +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/`. +All new features and fixes will be merged to this branch, so open your branch +from here. + +The following naming conventions apply for PRs: +- fix/ - patch/hotfix branches - feat/ - feature branches - doc/ - documentation branches - infra/ - infrastructure branches -Now you can implement your changes and test it 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. -During development, it is recommended to follow (conventional -commits)[https://www.conventionalcommits.org/en/v1.0.0/], it helps the project -maintainers when they review your code. +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. From 0da098afb61f9d9ce9f0c457bc803061e89f11bd Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:36:10 +0900 Subject: [PATCH 6/6] chore: mention branch basing conventions --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 791f660..4e302b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,8 +50,10 @@ If you would like to take ownership or assist with an issue on the issue tracker contribute a new change, please follow the guidelines below. Fork this repository and check out the code up to `prerelease/`. -All new features and fixes will be merged to this branch, so open your branch -from here. +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 @@ -61,7 +63,7 @@ The following naming conventions apply for PRs: 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 +will be merged to `prerelease/`, then `testing`, and after a live testing phase, to `stable` as well. It is recommended to follow