Skip to content

Commit 6c0e53d

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Add Templates for Issues and Pull Requests
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 1753a1c commit 6c0e53d

6 files changed

Lines changed: 138 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/--doc-report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: "Documentation Improvement"
3+
about: Your suggestions for improving the Documentation.
4+
title: ''
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill out as much of the below template and delete unnecessary text.
12+
Markdown Styling - https://commonmark.org/help/
13+
-->
14+
15+
### Description
16+
17+
> A brief description of the Documentation Improvement or New Section request.
18+
19+
20+
### Link to Documentation Page
21+
22+
> Where the confusion/inconsistency/incomplete documentation is.
23+
24+
<!--
25+
Link to Specific Aboutcode Documentation Page from http://aboutcode.readthedocs.io/
26+
-->
27+
28+
### Select Category
29+
<!-- Which of this label correctly describe your Bug Report -->
30+
31+
- Inconsistency []
32+
- New Section Request []
33+
- General Improvement []
34+
- Typo/Mistakes []
35+
- Other []
36+
37+
<!--
38+
Your help makes our Documentation better! We *deeply* appreciate your help in improving our Documentation.
39+
-->

‎.github/ISSUE_TEMPLATE/--feature-request.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "\U0001F9E8 Feature request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: new feature
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please fill out as much of the template as you can. Delete sections if unneccesary -->
11+
<!--
12+
Make Sure you've checked out Existing Issues
13+
-->
14+
15+
## Short Description
16+
<!-- Describe Your Idea -->
17+
18+
19+
## **How This Feature will help you/others**
20+
21+
22+
## **Possible Solution/Implementation Details**
23+
<!-- Describe the solution you'd like. -->
24+
25+
26+
## **Example/Links if Any**
27+
<!-- Link to already similar features across other OSS documentation -->
28+
29+
## **Can you help with this Feature**
30+
<!-- Pull Requests are much Appreciated -->
31+
32+
<!-- End. -->
33+
<!--
34+
Thank you! Your help makes our documentation better. We *deeply* appreciate it.
35+
-->

‎.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- This is the default Issue Template. Delete sections if unneccesary -->
2+
3+
## Short Description
4+
<!-- Description -->
5+
6+
## **Example/Links if Any**
7+
<!-- Links to Issue Location in aboutcode.readthedocs.io -->
8+
9+
<!-- Thank you for your help in improving our Documentation! -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Gitter Chat
4+
url: https://gitter.im/aboutcode-org/gsod-season-of-docs
5+
about: Please ask questions here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Delete Template sections if unneccesary -->
2+
<!-- Add issue number here (We encourage you to create the Issue First) -->
3+
<!-- You can also link the issue in Commit Messages -->
4+
5+
Fixes #0000
6+
7+
<!--
8+
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
9+
* [x] - Checked Box
10+
* [ ] - Unchecked Box
11+
-->
12+
13+
### Tasks
14+
15+
* [ ] PR is descriptively titled 📑 and links the original issue above 🔗
16+
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
17+
Run [tests](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html#continuous-integration) locally to check for errors.
18+
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
19+
20+
<!--
21+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
22+
if your tests fail at first!
23+
If tests do fail, click on the red `X` to learn why by reading the logs.
24+
Thanks!
25+
-->
26+
27+
<!-- Don't forget to Signoff -->

‎.github/config.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Configuration for welcome - https://github.com/behaviorbot/welcome
2+
3+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
4+
5+
# Comment to be posted to on first time issues
6+
newIssueWelcomeComment: |
7+
Thanks for opening your first issue! 👍🎉😄⚡️
8+
Do join our [Gitter channel](https://gitter.im/aboutcode-org/gsod-season-of-docs) for more discussions.
9+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
10+
11+
# Comment to be posted to on PRs from first time contributors in your repository
12+
newPRWelcomeComment: |
13+
Thanks for opening this pull request! 👍🎉😄⚡️
14+
Also please refer [Contributing related documentation](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html) for more help! 💿
15+
16+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
17+
18+
# Comment to be posted to on pull requests merged by a first time user
19+
firstPRMergeComment: |
20+
Congrats on merging your first pull request! 👍🎉😄⚡️
21+
Now that you've completed this, you can help on more [Issues](https://github.com/nexB/aboutcode/issues)
22+
23+
# It is recommend to include as many gifs and emojis as possible

0 commit comments

Comments
 (0)