Skip to content

Commit 9202df4

Browse files
steven-essersteven-esser
authored
Merge pull request #1827 from AyanSinhaMahapatra/issue-template
Add New Issue and Pull Request Templates
2 parents 383a878 + 9fe4d74 commit 9202df4

File tree

10 files changed

+408
-9
lines changed

10 files changed

+408
-9
lines changed

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill out as much of the below template and delete unnecessary text.
12+
Sample Bug Report - https://github.com/nexB/scancode-toolkit/issues/1778
13+
Markdown Styling - https://commonmark.org/help/
14+
-->
15+
16+
### Description
17+
18+
> Please leave a brief description of the bug or feature request:
19+
20+
21+
### How To Reproduce
22+
23+
> Tell us how to reproduce the issue.
24+
25+
<!-- Exact Commands -->
26+
27+
### System configuration
28+
29+
> For bug reports, it really helps us to know:
30+
31+
* What OS are you running on? (Windows/MacOS/Linux)
32+
* What version of scancode-toolkit was used to generate the scan file?
33+
* What installation method was used to install/run scancode? (pip/source download/other)
34+
35+
<!--
36+
Your help makes ScanCode Toolkit better! We *deeply* appreciate your help in improving ScanCode Toolkit.
37+
-->

‎.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 scancode-toolkit 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 Scancode-Toolkit Documentation Page from http://scancode-toolkit.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 ScanCode Toolkit better! We *deeply* appreciate your help in improving ScanCode Toolkit.
39+
-->

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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
13+
Existing Issues,
14+
Roadmap at https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html
15+
Milestones at https://github.com/nexB/scancode-toolkit/milestones
16+
-->
17+
18+
## Short Description
19+
20+
## Possible Labels
21+
<!-- What labels can be assigned - https://github.com/nexB/scancode-toolkit/labels -->
22+
23+
- new feature
24+
25+
## Select Category
26+
<!-- Which of this label correctly describe your feature Request -->
27+
28+
- Enhancement []
29+
- Add License/Copyright []
30+
- Scan Feature []
31+
- Packaging []
32+
- Documentation []
33+
- Expand Support []
34+
- Other []
35+
36+
## **Describe the Update**
37+
<!-- What feature is requested. -->
38+
39+
40+
## **How This Feature will help you/your organization**
41+
42+
43+
## **Possible Solution/Implementation Details**
44+
<!-- Describe the solution you'd like. -->
45+
46+
47+
## **Example/Links if Any**
48+
<!-- Link to already similar features across other OSS -->
49+
50+
## **Can you help with this Feature**
51+
<!-- Pull Requests are much Appreciated -->
52+
53+
<!-- End. -->
54+
<!--
55+
Thank you! Your help makes ScanCode Toolkit better. We *deeply* appreciate it.
56+
-->

‎.github/ISSUE_TEMPLATE/--first-timers-only.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
name: "First Timers Only issue"
3+
about: Issue based guide for new OSS contributors to solve a very easy Issue
4+
title: ''
5+
labels: 'first timers only'
6+
assignees: ''
7+
8+
---
9+
10+
## Introduction
11+
12+
### 🤔 What you will have to Do
13+
14+
You'll have to contribute to the ScanCode Toolkit Documentation, to solve inconsistensies/update
15+
docs.
16+
17+
- You'll find an issue from [here](https://github.com/nexB/scancode-toolkit/issues/1826)
18+
- Create an issue using this template [here]()
19+
- And then solve it (Follow the Task List Below).
20+
21+
### A first-timer's Issue
22+
23+
A [first-timers-only issue](https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only)
24+
means we've worked to make it more legible to folks who either **haven't contributed to our codebase before,
25+
or even folks who haven't contributed to open source before**.
26+
27+
If that's you, we're interested in helping you take the first step and can answer questions and
28+
help you out as you do. Note that we're especially interested in contributions from people from
29+
groups underrepresented in free and open source software!
30+
31+
We know that the process of creating a pull request is the biggest barrier for new contributors and
32+
this issue is for you. 💝
33+
34+
If you have contributed before, **consider leaving this one for someone new**, and looking through
35+
our general [good first issue](https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue) issues. Thanks!
36+
37+
### 🤔 What you will need to know.
38+
39+
Nothing. This issue is meant to welcome you to Open Source :)
40+
You need to learn basic reStructuredText formatting, and very basic linux/git commands.
41+
We are happy to walk you through the process.
42+
43+
Useful Links -
44+
45+
* [reStructuredText basics](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
46+
* [Git Basics](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository)
47+
48+
Remember, basic help is just one Google Search away!
49+
50+
### Please keep us updated
51+
52+
💬⏰ - We encourage contributors to be respectful to the community and provide an update
53+
**within a week** of claiming a first-timers-only issue. We're happy to keep it assigned to you as
54+
long as you need if you update us with a request for more time or help, but if we don't see any
55+
activity a week after you claim it we may reassign it to give someone else a chance.
56+
Thank you in advance!
57+
58+
If this happens to you, don't sweat it! Grab another open issue.
59+
60+
### Is someone else already working on this?
61+
62+
🔗- We encourage contributors to link to the original issue in their pull request so all users can
63+
easily see if someone's already started on it.
64+
65+
👥- **If someone seems stuck, offer them some help!** Otherwise,
66+
[take a look at some other issues you can help with](https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only).
67+
Thanks!
68+
69+
### 🤔❓ Questions?
70+
71+
Leave a comment below!
72+
73+
## Issue
74+
75+
### Issue Desription
76+
<!--
77+
Copy and Paste the Issue Description from the Parent Issue.
78+
Add details and if you are solving only a part of the parent issue, mention only that part.
79+
-->
80+
81+
### 📋 Step by Step
82+
<!--
83+
Make sure all these boxes are checked before your pull request (PR) is ready to be reviewed and merged.
84+
* [x] - Checked Box
85+
* [ ] - Unchecked Box
86+
This task list makes it easier for the maintainers to track your Progress, so update it as you finish tasks.
87+
-->
88+
89+
- [ ] 🙋 **Issue Claimed**: Make sure you've claimed this issue from the
90+
[First Timers Only Issues List](https://github.com/nexB/scancode-toolkit/issues/1826) and you've been
91+
assigned to this Issue by a maintainer.
92+
93+
- [ ] **Review Guidelines** Check out our Code of Conduct and Contributing Guidelines before you start working.
94+
95+
- [ ] **Refer Documentation** Refer [docuementation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_doc.html)
96+
for more help on the contribution process and to understand our Sphinx and reStructuredText built
97+
documentation generation better.
98+
99+
- [ ] **Build Docs Locally** Fork the repository, clone it to your local system, and setup a
100+
virtualenv to build the docs locally.
101+
102+
- [ ] 📝 **Update** Fix the errors/inconsistencies.
103+
104+
- [ ] **Run Test Scripts** Run the Test Scripts to make sure Docs are building successfully and are style compliant.
105+
106+
- [ ] 💾 **Commit** your changes,
107+
108+
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
109+
110+
1. If you are familiar with the terminal or would like to learn it,
111+
[here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
112+
on how to send a pull request using the terminal.
113+
114+
2. You can also go to your Fork of ScanCode Toolkit and open a pull request from the branch you've pushed to.
115+
Always create the Pull Request with the develop branch, unless otherwise instructed by maintainers.
116+
117+
- [ ] 🔗 **Link the Parent Issue** Refer [Documentation]()
118+
on creating First Timers Only Issues for more help.
119+
120+
- [ ] 🏁 **Done** Ask in comments for a review :)

‎.github/ISSUE_TEMPLATE/--good-first-issue.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
name: "Solving a Good First Issue"
3+
about: Issue based guide for new contributors to solve a "Good First Issue"
4+
title: ''
5+
labels: 'solving good first issue'
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Don't edit the text. -->
11+
12+
A [good first issue](https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue)
13+
means it's recommended for people who **haven't contributed to our codebase before**.
14+
If you've solved a good first issue and want to help with more, you are welocome too!
15+
16+
If that's you, we're interested in helping you take the first step and can answer questions and
17+
help you out as you do. Note that we're especially interested in contributions from people from
18+
groups underrepresented in free and open source software!
19+
20+
We feel that the process of solving easy issues is great for new contributors, as they help in
21+
understanding the codebase, building up confidence and get to know the Organization closely.
22+
23+
Thanks for deciding to contribute and welcome to ScanCode Toolkit. 💝
24+
25+
### Please keep us updated
26+
27+
💬⏰ - We encourage contributors to be respectful to the community and provide an update
28+
**within a week** of claiming a good-first-issue. We're happy to keep it assigned to you for longer
29+
if you update us with a request for more time or help, but if we don't see any activity a week
30+
after you claim it we may reassign it to give someone else a chance. Thank you in advance!
31+
32+
If this happens to you, don't sweat it! Grab another open issue.
33+
34+
### Is someone else already working on this?
35+
36+
🔗- We encourage contributors to link to the original issue in their pull request so all users can
37+
easily see if someone's already started on it.
38+
39+
👥- **If someone seems stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue). Thanks!
40+
41+
### 📋 Step by Step
42+
<!--
43+
Make sure all these boxes are checked before your pull request (PR) is ready to be reviewed and merged.
44+
* [x] - Checked Box
45+
* [ ] - Unchecked Box
46+
-->
47+
48+
- [ ] 🙋 **Claim this issue**: Make sure you've already claimed this issue from the
49+
[Good First Issues List](https://github.com/nexB/scancode-toolkit/issues/1825) and you've been
50+
assigned to this Issue by a maintainer. You should have your name beside the issue,
51+
in the list, added by a maintainer.
52+
53+
- [ ] **Reproduce** Try to reproduce the problem in the most minimal way with a command line
54+
invocation of scancode as outlined above, trying to find a few files that make this fail.
55+
56+
- [ ] **Create a Unit test** Once you have a minimally reproducible problem, create a unit test
57+
(that is failing for now) that reproduces the problem. Assert the things that should be there
58+
in the results.
59+
60+
- [ ] **Come up with a Solution** Look at the failure trace and try to understand why this is not
61+
working and which places the code may need fixing.
62+
63+
- [ ] 📝 **Code your Solution**
64+
65+
- [ ] 📝 **Run the tests locally**
66+
Refer [Documentation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests)
67+
68+
- [ ] 💾 **Commit and Push** your changes. Do check out this documentation on
69+
[writing good commit messages](https://aboutcode.readthedocs.io/en/latest/aboutcode-docs/writing_good_commit_messages.html)
70+
71+
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
72+
73+
1. If you are familiar with the terminal or would like to learn it,
74+
[here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
75+
on how to send a pull request using the terminal.
76+
77+
2. You can also go to your Fork of ScanCode Toolkit and open a pull request from the branch you've pushed to.
78+
Always create the Pull Request with the develop branch, unless otherwise instructed by maintainers.
79+
80+
- [ ] Make Sure all the Tests Pass
81+
82+
- [ ] 🏁 **Done** Ask in comments for a review :)
83+
84+
### 🤔❓ Questions?
85+
86+
Leave a comment below!

‎.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, i.e. this opens when a blank issue is opened -->
2+
3+
<!-- Description -->
4+
5+
<!-- How to reproduce: -->
6+
7+
<!-- System Configuration -->
8+
9+
<!-- Thanks for your help! -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Gitter Chat
4+
url: https://gitter.im/aboutcode-org/discuss
5+
about: Please ask questions here.
6+
- name: Code Of Conduct
7+
url: https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst
8+
about: This space is protected by our Code Of Conduct.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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+
* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst)
16+
* [ ] PR is descriptively titled 📑 and links the original issue above 🔗
17+
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
18+
Run [tests](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests) locally to check for errors.
19+
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
20+
21+
<!--
22+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
23+
if your tests fail at first!
24+
If tests do fail, click on the red `X` to learn why by reading the logs.
25+
Thanks!
26+
-->
27+
28+
<!-- Don't forget to Signoff -->

0 commit comments

Comments
 (0)