tworu/dzgui
1
0
Fork 0
mirror of https://github.com/aclist/dztui.git synced 2026-08-25 17:32:36 +02:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

chore: reword CONTRIBUTING.md

Browse Source 
Corrected some typos and reworded passive voice/some sections for
brevity.
This commit is contained in:
aclist 2025-10-25 11:51:19 +09:00
parent dccdffe761
commit 506c82e86a
1 changed files with 35 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
CONTRIBUTING.md
View File

@ -1,16 +1,15 @@
# Introduction # 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 This guide goes over development conventions and best practices for contributors.
of development and aims to ease the beginning of a contribution. 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 If you encounter a problem with DZGUI, you can submit tickets on the GitHub
(link)[https://github.com/aclist/dzgui-devel/issues] where you can submit (issue tracker)[https://github.com/aclist/dzgui-devel/issues] under the
tickets. If you need help troubleshooting a problem, submit a ticket. There is a `troubleshooting` tag.
category called `troubleshooting` which is exactly what you need.
# How can I help the project? # 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 Before making any contribution, please read the `CODE_OF_CONDUCT.md` and act
accordingly. 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 version are you using?
- What distribution are you using? - What distribution are you using?
- What is the issue that you found? - What is the issue that you found?
- How can we reproduce the issue? - 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 ## Requesting a feature
(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 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 Please note that this is a community project, so it takes time for us to develop
you would like to have implemented you can contribute code to this project. For features. Putting in a feature request does not mean that it will be implemented,
this, you may fork this repository and checkout to but we will do our best to support as many cool ideas as possible.
`prerelease/<latest-version>`. All new features and fixes will be merged to this
branch, so open your branch from here. Name it according to our convention: ## Contributing code or documentation
- fix/<your-fix> - fix branches
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/<latest-version>`.
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/<your-fix> - patch/hotfix branches
- feat/<your-feature> - feature branches - feat/<your-feature> - feature branches
- doc/<your-doc-branch> - documentation branches - doc/<your-doc-branch> - documentation branches
- infra/<your-infra-branch> - infrastructure branches - infra/<your-infra-branch> - 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 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 `prerelease/<latest-version>`, then `testing` and after a live
testing phase, to `stable` as well. testing phase, to `stable` as well.
During development, it is recommended to follow (conventional It is recommended to follow
commits)[https://www.conventionalcommits.org/en/v1.0.0/], it helps the project (Conventional Commits)[https://www.conventionalcommits.org/en/v1.0.0/], as this
maintainers when they review your code. integrates well with tooling and helps the project review your code.