-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: reorganize issue templates for better clarity and usability
- Loading branch information
Showing
6 changed files
with
144 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Workflow | ||
|
||
All needed information about the [Git](https://git-scm.com) workflow. | ||
|
||
## Creating a new branch | ||
|
||
In the best case, the branch should have a short summary. This avoids conflict with other branches, that also have similar changes. | ||
|
||
- `git checkout -b add-docs-git-workflow develop` - to create a new branch from the **develop** branch | ||
|
||
## Commit messages for the pull requests | ||
|
||
Those commit messages are based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) standards | ||
|
||
- build: changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
- ci: changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs) | ||
- 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: changes that have been reverted | ||
- test: adding missing tests or correcting existing tests | ||
- BREAKING CHANGE/BREAKING CHANGES: the commits that contains **BREAKING CHANGE** or **BREAKING CHANGES** in their body will be considered breaking changes | ||
|
||
## Creating a pull request | ||
|
||
After pushing your branch, you need to create a pull request for code review and test. Select the branch from, which you created the new branch as the target branch (at the moment **develop** branch is default). The title of the pull request can have any description. | ||
|
||
## Creating a release | ||
|
||
To create a release you need to enter the following commands: | ||
|
||
- `git checkout develop`: this command switches your local repository to the **"develop"** branch | ||
|
||
- `git pull origin develop`: this command fetches the latest changes from the remote **"develop"** branch | ||
|
||
- `git checkout -b release/30042023222012`: this command creates a new branch | ||
|
||
- `git push`: this command pushes your local branch changes to the remote repository | ||
|
||
Remember that the newly created pull request must now be targeted to the **"main"** branch and all tests must be successfully completed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: Report a bug | ||
title: "Summarize the issue briefly." | ||
description: Please describe any bugs or issues you have encountered. | ||
labels: [bug] | ||
assignees: "" | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Prerequisites | ||
description: Take a couple minutes to help our maintainers work faster. | ||
options: | ||
- label: I have read the [contributing guidelines](https://github.com/krudi/ansible-role-nvm/blob/main/.github/CONTRIBUTING.md) | ||
required: true | ||
- type: textarea | ||
id: gh-issue-description | ||
attributes: | ||
label: Describe the issue | ||
description: Provide a summary of the issue and detail the actions, that led to the issue for effective communication and troubleshooting. | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: gh-operation-system | ||
attributes: | ||
label: On which operating system(s) are you experiencing the issue? | ||
multiple: true | ||
options: | ||
- Windows | ||
- macOS | ||
- Linux | ||
- Android | ||
- iOS | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: gh-browser | ||
attributes: | ||
label: Which browser(s) are you experiencing the issue with? | ||
multiple: true | ||
options: | ||
- Chrome | ||
- Safari | ||
- Firefox | ||
- Microsoft Edge | ||
- Opera |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Send an E-Mail | ||
url: mailto:patryk.kudlik@gmail.com | ||
about: Please do not use this E-Mail to post issues or feature requests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Feature request | ||
title: "Suggest a new feature" | ||
description: Propose new or enhanced features to add. | ||
labels: [feature] | ||
assignees: "" | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Prerequisites | ||
description: Take a couple minutes to help our maintainers work faster. | ||
options: | ||
- label: I have read the [contributing guidelines](https://github.com/krudi/ansible-role-nvm/blob/main/.github/CONTRIBUTING.md) | ||
required: true | ||
- type: textarea | ||
id: gh-proposal | ||
attributes: | ||
label: Proposal | ||
description: Please give detailed suggestions for additions, including relevant links to prior examples, screenshots, or live demonstrations where applicable | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: gh-reason | ||
attributes: | ||
label: Motivation and context | ||
description: Explain why this change is necessary or beneficial, and the issues it might address. | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Pull request template | ||
|
||
## Type of pull request | ||
|
||
- [ ] Bug fix/fixes (non-breaking changes that fix issues) | ||
- [ ] New feature/features (non-breaking changes that add functionality) | ||
- [ ] Code refactoring (non-breaking changes) | ||
- [ ] Breaking change/changes (fixes or functionality that alter existing functionality) | ||
- [ ] Documentation change/changes (add new documentation or fix) | ||
- [ ] Test change/changes (add new test/tests or fix) | ||
|
||
## Checklist | ||
|
||
- [ ] I have read the [Contributing Guidelines](https://github.com/krudi/ansible-role-nvm/main/.github/CONTRIBUTING.md) | ||
- [ ] My code follows the code style (`npm run lint:full`) | ||
- [ ] I added tests to cover my changes | ||
- [ ] I passed new and existing tests | ||
|
||
## Related topics | ||
|
||
- [Example link](https://example.com) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Security Policy | ||
|
||
## Reporting a Vulnerability | ||
|
||
Please report all vulnerabilities to [patryk.kudlik@gmail.com](mailto:patryk.kudlik@gmail.com). |