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] 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.