ventoy-adamsdesk-theme/CONTRIBUTING.md

# Contributing

- [Code Of Conduct](#code-of-conduct)
  - [Principles](#principles)
  - [Violations](#violations)
  - [Feedback](#feedback)
- [Submission Guidelines](#submission-guidelines)
  - [Submitting An Issue](#submitting-an-issue)
  - [Commenting On A Issue](#commenting-on-a-issue)
  - [Issue Closure](#issue-closure)
  - [Issue Re-Opening](#issue-re-opening)
- [Commit Message Guidelines](#commit-message-guidelines)
  - [Commit Message Format](#commit-message-format)
    - [Type](#type)
    - [Subject](#subject)
    - [Body](#body)
    - [Footer](#footer)

## Code Of Conduct

As contributors and maintainers of the project, we pledge to respect everyone who contributes by posting issues,
updating documentation, submitting pull requests, providing feedback in comments and any other associated project
activities.

### Principles

- Be constructive
- Be positive
- Be respectful
- Be courtesy
- Be honest
- Be trustworthy
- Never resort to personal attacks
- Never troll
- Never publicly or privately harass
- Never insult

### Violations

If a community member associated to the project violates this code of conduct, the maintainers of the project may take
appropriate actions as deemed necessary. Such actions maybe but not limited to, removing issues, comments, public
relations and/or blocking accounts.

### Feedback

If you are subject to or witness of unacceptable behaviour or have any other
concerns, please contact us.

## Submission Guidelines

### Submitting An Issue

- All issues must be submitted using [Forgejo issues](https://git.nixnet.services/adamsdesk/ventoy-adamsdesk-theme/issues).
- Search first before creating an issue.
- Preview the issue to ensure it is rendering as intended.
- Be as descriptive as possible.
- Provide steps required to re-produce.
- Utilize the provided form fields.
- Attach necessary reference documents (error messages, screenshots, sample
data, logs, etc.).
- **Do Not** submit or reply to an issue outside Forgejo.
- **Do Not** submit multiple issues within one submission.
- **Do Not** duplicate an issue.

### Commenting On A Issue

- **Do Not** comment on an issue outside Forgejo.
- Stay on topic per the issue description.

### Issue Closure

Valid reasons for closing an issue:

- Duplicate issue.
  -  A reference to the duplicate must be added before closure.
- Lacks enough information to re-produce.
- No longer relevant.
- Off-topic.
- Resolved.
- Multiple issues within the submission.
- Will not be resolved.
  - Provide a reason that this issue will not be resolved.

### Issue Re-Opening

- Reasons for re-opening:
  - Issue has not been resolved.
- A detailed comment is required.
- **Do Not** re-open an issue that was closed more than 2 months ago. Instead
Create a new issue.

## Commit Message Guidelines

Git commit messages must adhere to a specific format. This is done to ensure
good communication, consistency and readability.

### Commit Message Format

Each commit message consists of three properties as shown below.

Property | Sub-Property  | Character Limit | Mandatory
---------|---------------|-----------------|----------
header   | type, subject | 100             | True
body     |               | 100             | False
footer   |               | 100             | False

Structure
```
<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

#### Type

Use one of the following applicable type.

- build
  - Changes that affect the build system or external dependencies.
- ci
  - Changes continuous integration (CI) configuration files and scripts.
- docs
  - Documentation only changes.
- feat
  - A new feature.
- fix
  - A bug fix.
- perf
  - A code change that improves performance.
- refactor
  - A code change that neither fixes a bug nor adds a feature.
- revert
  - When commit reverts a previous commit.
- style
  - Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.).
- test
  - Adding or modifying tests.

#### Subject

- Be concise description of the change.
- Use the imperative, present tense: "change" not "changed" nor "changes".
- Do not capitalize the first letter.
- No period/dot (.) at the end.

#### Body

- Use the imperative, present tense: "change" not "changed" nor "changes".
- Include the motivation for the change and contrast this with previous
behaviour.
- If commit type is **revert**, in the body state `This reverts commit <hash>`.
The `<hash>` is the hash value of the commit being reverted.

#### Footer

- Reference Forgejo issue(s) that the commit closes.
- State breaking changes.
  - Breaking changes start with **BREAKING CHANGE:** with a space or two
  newlines. Following is the description of change, motivation for change and migration notes.
Initial commit 2021-02-14 02:34:22 +00:00			`# Contributing`

			`- [Code Of Conduct](#code-of-conduct)`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`- [Principles](#principles)`
			`- [Violations](#violations)`
			`- [Feedback](#feedback)`
Initial commit 2021-02-14 02:34:22 +00:00			`- [Submission Guidelines](#submission-guidelines)`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`- [Submitting An Issue](#submitting-an-issue)`
			`- [Commenting On A Issue](#commenting-on-a-issue)`
			`- [Issue Closure](#issue-closure)`
			`- [Issue Re-Opening](#issue-re-opening)`
Initial commit 2021-02-14 02:34:22 +00:00			`- [Commit Message Guidelines](#commit-message-guidelines)`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`- [Commit Message Format](#commit-message-format)`
			`- [Type](#type)`
			`- [Subject](#subject)`
			`- [Body](#body)`
			`- [Footer](#footer)`
Initial commit 2021-02-14 02:34:22 +00:00
			`## Code Of Conduct`

			`As contributors and maintainers of the project, we pledge to respect everyone who contributes by posting issues,`
			`updating documentation, submitting pull requests, providing feedback in comments and any other associated project`
			`activities.`

			`### Principles`

			`- Be constructive`
			`- Be positive`
			`- Be respectful`
			`- Be courtesy`
			`- Be honest`
			`- Be trustworthy`
			`- Never resort to personal attacks`
			`- Never troll`
			`- Never publicly or privately harass`
			`- Never insult`

			`### Violations`

			`If a community member associated to the project violates this code of conduct, the maintainers of the project may take`
			`appropriate actions as deemed necessary. Such actions maybe but not limited to, removing issues, comments, public`
			`relations and/or blocking accounts.`

			`### Feedback`

docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`If you are subject to or witness of unacceptable behaviour or have any other`
Initial commit 2021-02-14 02:34:22 +00:00			`concerns, please contact us.`

			`## Submission Guidelines`

			`### Submitting An Issue`

docs: replace reference of gitlab to forgejo 2024-02-08 21:18:15 +00:00			`- All issues must be submitted using [Forgejo issues](https://git.nixnet.services/adamsdesk/ventoy-adamsdesk-theme/issues).`
Initial commit 2021-02-14 02:34:22 +00:00			`- Search first before creating an issue.`
			`- Preview the issue to ensure it is rendering as intended.`
			`- Be as descriptive as possible.`
			`- Provide steps required to re-produce.`
			`- Utilize the provided form fields.`
			`- Attach necessary reference documents (error messages, screenshots, sample`
			`data, logs, etc.).`
docs: replace reference of gitlab to forgejo 2024-02-08 21:18:15 +00:00			`- Do Not submit or reply to an issue outside Forgejo.`
Initial commit 2021-02-14 02:34:22 +00:00			`- Do Not submit multiple issues within one submission.`
			`- Do Not duplicate an issue.`

			`### Commenting On A Issue`

docs: replace reference of gitlab to forgejo 2024-02-08 21:18:15 +00:00			`- Do Not comment on an issue outside Forgejo.`
Initial commit 2021-02-14 02:34:22 +00:00			`- Stay on topic per the issue description.`

			`### Issue Closure`

			`Valid reasons for closing an issue:`

			`- Duplicate issue.`
			`- A reference to the duplicate must be added before closure.`
			`- Lacks enough information to re-produce.`
			`- No longer relevant.`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`- Off-topic.`
Initial commit 2021-02-14 02:34:22 +00:00			`- Resolved.`
			`- Multiple issues within the submission.`
			`- Will not be resolved.`
			`- Provide a reason that this issue will not be resolved.`

			`### Issue Re-Opening`

			`- Reasons for re-opening:`
			`- Issue has not been resolved.`
			`- A detailed comment is required.`
			`- Do Not re-open an issue that was closed more than 2 months ago. Instead`
			`Create a new issue.`

			`## Commit Message Guidelines`

			`Git commit messages must adhere to a specific format. This is done to ensure`
			`good communication, consistency and readability.`

			`### Commit Message Format`

			`Each commit message consists of three properties as shown below.`

			`Property \| Sub-Property \| Character Limit \| Mandatory`
			`---------\|---------------\|-----------------\|----------`
			`header \| type, subject \| 100 \| True`
			`body \| \| 100 \| False`
			`footer \| \| 100 \| False`

			`Structure`
			```
			`<type>: <subject>`
			`<BLANK LINE>`
			`<body>`
			`<BLANK LINE>`
			`<footer>`
			```

			`#### Type`

			`Use one of the following applicable type.`

			`- build`
			`- Changes that affect the build system or external dependencies.`
			`- ci`
			`- Changes continuous integration (CI) configuration files and scripts.`
			`- docs`
			`- Documentation only changes.`
			`- feat`
			`- A new feature.`
			`- fix`
			`- A bug fix.`
			`- perf`
			`- A code change that improves performance.`
			`- refactor`
			`- A code change that neither fixes a bug nor adds a feature.`
			`- revert`
			`- When commit reverts a previous commit.`
			`- style`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`- Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.).`
Initial commit 2021-02-14 02:34:22 +00:00			`- test`
			`- Adding or modifying tests.`

			`#### Subject`

			`- Be concise description of the change.`
			`- Use the imperative, present tense: "change" not "changed" nor "changes".`
			`- Do not capitalize the first letter.`
			`- No period/dot (.) at the end.`

			`#### Body`

			`- Use the imperative, present tense: "change" not "changed" nor "changes".`
			`- Include the motivation for the change and contrast this with previous`
docs: fix grammar and spelling 2024-02-08 21:14:23 +00:00			`behaviour.`
Initial commit 2021-02-14 02:34:22 +00:00			- If commit type is revert, in the body state `This reverts commit <hash>`.
			The `<hash>` is the hash value of the commit being reverted.

			`#### Footer`

docs: replace reference of gitlab to forgejo 2024-02-08 21:18:15 +00:00			`- Reference Forgejo issue(s) that the commit closes.`
Initial commit 2021-02-14 02:34:22 +00:00			`- State breaking changes.`
			`- Breaking changes start with BREAKING CHANGE: with a space or two`
			`newlines. Following is the description of change, motivation for change and migration notes.`