Compare commits
2 Commits
d01d4acd8e
...
1d95413efa
Author | SHA1 | Date |
---|---|---|
Adam | 1d95413efa | |
Adam | 49245844a7 |
|
@ -1,8 +1,20 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
- [Code Of Conduct](#code-of-conduct)
|
- [Code Of Conduct](#code-of-conduct)
|
||||||
|
- [Principles](#principles)
|
||||||
|
- [Violations](#violations)
|
||||||
|
- [Feedback](#feedback)
|
||||||
- [Submission Guidelines](#submission-guidelines)
|
- [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 Guidelines](#commit-message-guidelines)
|
||||||
|
- [Commit Message Format](#commit-message-format)
|
||||||
|
- [Type](#type)
|
||||||
|
- [Subject](#subject)
|
||||||
|
- [Body](#body)
|
||||||
|
- [Footer](#footer)
|
||||||
|
|
||||||
## Code Of Conduct
|
## Code Of Conduct
|
||||||
|
|
||||||
|
@ -31,14 +43,14 @@ relations and/or blocking accounts.
|
||||||
|
|
||||||
### Feedback
|
### Feedback
|
||||||
|
|
||||||
If you are subject to or witness of unacceptable behavior or have any other
|
If you are subject to or witness of unacceptable behaviour or have any other
|
||||||
concerns, please contact us.
|
concerns, please contact us.
|
||||||
|
|
||||||
## Submission Guidelines
|
## Submission Guidelines
|
||||||
|
|
||||||
### Submitting An Issue
|
### Submitting An Issue
|
||||||
|
|
||||||
- All issues must be submitted using GitLab issues.
|
- All issues must be submitted using [Forgejo issues](https://git.nixnet.services/adamsdesk/ventoy-adamsdesk-theme/issues).
|
||||||
- Search first before creating an issue.
|
- Search first before creating an issue.
|
||||||
- Preview the issue to ensure it is rendering as intended.
|
- Preview the issue to ensure it is rendering as intended.
|
||||||
- Be as descriptive as possible.
|
- Be as descriptive as possible.
|
||||||
|
@ -46,13 +58,13 @@ concerns, please contact us.
|
||||||
- Utilize the provided form fields.
|
- Utilize the provided form fields.
|
||||||
- Attach necessary reference documents (error messages, screenshots, sample
|
- Attach necessary reference documents (error messages, screenshots, sample
|
||||||
data, logs, etc.).
|
data, logs, etc.).
|
||||||
- **Do Not** submit or reply to an issue outside of GitLab.
|
- **Do Not** submit or reply to an issue outside Forgejo.
|
||||||
- **Do Not** submit multiple issues within one submission.
|
- **Do Not** submit multiple issues within one submission.
|
||||||
- **Do Not** duplicate an issue.
|
- **Do Not** duplicate an issue.
|
||||||
|
|
||||||
### Commenting On A Issue
|
### Commenting On A Issue
|
||||||
|
|
||||||
- **Do Not** comment on a issue outside of GitLab.
|
- **Do Not** comment on an issue outside Forgejo.
|
||||||
- Stay on topic per the issue description.
|
- Stay on topic per the issue description.
|
||||||
|
|
||||||
### Issue Closure
|
### Issue Closure
|
||||||
|
@ -63,7 +75,7 @@ Valid reasons for closing an issue:
|
||||||
- A reference to the duplicate must be added before closure.
|
- A reference to the duplicate must be added before closure.
|
||||||
- Lacks enough information to re-produce.
|
- Lacks enough information to re-produce.
|
||||||
- No longer relevant.
|
- No longer relevant.
|
||||||
- Off topic.
|
- Off-topic.
|
||||||
- Resolved.
|
- Resolved.
|
||||||
- Multiple issues within the submission.
|
- Multiple issues within the submission.
|
||||||
- Will not be resolved.
|
- Will not be resolved.
|
||||||
|
@ -122,7 +134,7 @@ Use one of the following applicable type.
|
||||||
- revert
|
- revert
|
||||||
- When commit reverts a previous commit.
|
- When commit reverts a previous commit.
|
||||||
- style
|
- style
|
||||||
- Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.).
|
- Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.).
|
||||||
- test
|
- test
|
||||||
- Adding or modifying tests.
|
- Adding or modifying tests.
|
||||||
|
|
||||||
|
@ -137,13 +149,13 @@ Use one of the following applicable type.
|
||||||
|
|
||||||
- Use the imperative, present tense: "change" not "changed" nor "changes".
|
- Use the imperative, present tense: "change" not "changed" nor "changes".
|
||||||
- Include the motivation for the change and contrast this with previous
|
- Include the motivation for the change and contrast this with previous
|
||||||
behavior.
|
behaviour.
|
||||||
- If commit type is **revert**, in the body state `This reverts commit <hash>`.
|
- If commit type is **revert**, in the body state `This reverts commit <hash>`.
|
||||||
The `<hash>` is the hash value of the commit being reverted.
|
The `<hash>` is the hash value of the commit being reverted.
|
||||||
|
|
||||||
#### Footer
|
#### Footer
|
||||||
|
|
||||||
- Reference GitLab issue(s) that the commit closes.
|
- Reference Forgejo issue(s) that the commit closes.
|
||||||
- State breaking changes.
|
- State breaking changes.
|
||||||
- Breaking changes start with **BREAKING CHANGE:** with a space or two
|
- Breaking changes start with **BREAKING CHANGE:** with a space or two
|
||||||
newlines. Following is the description of change, motivation for change and migration notes.
|
newlines. Following is the description of change, motivation for change and migration notes.
|
||||||
|
|
Loading…
Reference in New Issue