Skip to content

Commit dc2dd33

Browse files
author
Nabeel Shakeel
committed
docs: update docs of template and add issue template config
1 parent a39fd69 commit dc2dd33

File tree

5 files changed

+15
-12
lines changed

5 files changed

+15
-12
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Please ensure your commit adheres to the [Conventional Commits Specification](ht
2828
Please ensure your PR adheres to the following guidelines:
2929

3030
- One item per Pull Request
31-
- For feature, follow this branch naming convention `feature-ISSUE_NUMBER-short-description-of-feature`
32-
- For example: `feature-1-contributor-guide-for-project`
33-
- For bug and other update, follow `fix-ISSUE_NUMBER-short-description-of-fix`
31+
- For feature, follow this branch naming convention `feature/ISSUE-ISSUE_NUMBER-short-description-of-feature`
32+
- For example: `feature/ISSUE-ISSUE_NUMBER-contributor-guide-for-project`
33+
- For bug and other update, follow `fix/ISSUE-ISSUE_NUMBER-short-description-of-fix`
3434
- PR title should follow the convention `Feature | ISSUE_NUMBER | Short Description Of Feature`
3535
- For example: `Feature | Issue #2 | Contributor Guide For Project`
36-
- For bugs and fixes, replace feature with `Fix` remaining will be the same
36+
- For bugs and other fixes, replace feature with any of these values `FIX, CI, DOCS, PERF, TEST, STYLE`
3737
- Keep PR descriptions short and simple
38-
- Link your PR with Github issue by using words `Closes #ISSUE_NUMBER` or `Fixes #ISSUE_NUMBER`, refer to this [doc](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
38+
- Link your PR with Github issue by using words `closes #ISSUE_NUMBER` or `fixes #ISSUE_NUMBER`, refer to this [doc](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
3939
- Make an individual pull request for each issue
4040
- Check your spelling and grammar
4141

template-contrib/CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Please ensure your commit adheres to the [Conventional Commits Specification](ht
2828
Please ensure your PR adheres to the following guidelines:
2929

3030
- One item per Pull Request
31-
- For feature, follow this branch naming convention `feature-ISSUE_NUMBER-short-description-of-feature`
32-
- For example: `feature-1-contributor-guide-for-project`
33-
- For bug and other update, follow `fix-ISSUE_NUMBER-short-description-of-fix`
31+
- For feature, follow this branch naming convention `feature/ISSUE-ISSUE_NUMBER-short-description-of-feature`
32+
- For example: `feature/ISSUE-ISSUE_NUMBER-contributor-guide-for-project`
33+
- For bug and other update, follow `fix/ISSUE-ISSUE_NUMBER-short-description-of-fix`
3434
- PR title should follow the convention `Feature | ISSUE_NUMBER | Short Description Of Feature`
3535
- For example: `Feature | Issue #2 | Contributor Guide For Project`
36-
- For bugs and fixes, replace feature with `Fix` remaining will be the same
36+
- For bugs and other fixes, replace feature with any of these values `FIX, CI, DOCS, PERF, TEST, STYLE`
3737
- Keep PR descriptions short and simple
38-
- Link your PR with Github issue by using words `Closes #ISSUE_NUMBER` or `Fixes #ISSUE_NUMBER`, refer to this [doc](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
38+
- Link your PR with Github issue by using words `closes #ISSUE_NUMBER` or `fixes #ISSUE_NUMBER`, refer to this [doc](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
3939
- Make an individual pull request for each issue
4040
- Check your spelling and grammar
4141

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ name: Feature
33
about: Open a request for new feature or enhancements
44
title: '[Feature]: '
55
labels: feature
6-
assignees: nabeel-shakeel
76
---
87

98
Thanks for taking the time to fill out this feature request! To address this request as fast as possible, we need some information.
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ name: Fix
33
about: File a fix or bug to help us improve
44
title: '[Fix]: '
55
labels: bug
6-
assignees: nabeel-shakeel
76
---
87

98
Thanks for taking the time to fill out this fix report! To address this fix as fast as possible, we need some information

template-issue/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Your Contact Support
4+
url: https://www.google.com
5+
about: Please ask and answer questions here.

0 commit comments

Comments
 (0)