diff --git a/.github/ISSUE_TEMPLATE/--bug-report.md b/.github/ISSUE_TEMPLATE/--bug-report.md new file mode 100644 index 00000000000..7d5e82e4065 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--bug-report.md @@ -0,0 +1,37 @@ +--- +name: "\U0001F41B Bug report" +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + + + +### Description + +> Please leave a brief description of the bug or feature request: + + +### How To Reproduce + +> Tell us how to reproduce the issue. + + + +### System configuration + +> For bug reports, it really helps us to know: + +* What OS are you running on? (Windows/MacOS/Linux) +* What version of scancode-toolkit was used to generate the scan file? +* What installation method was used to install/run scancode? (pip/source download/other) + + diff --git a/.github/ISSUE_TEMPLATE/--doc-report.md b/.github/ISSUE_TEMPLATE/--doc-report.md new file mode 100644 index 00000000000..b24fcbdfc70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--doc-report.md @@ -0,0 +1,39 @@ +--- +name: "Documentation Improvement" +about: Your suggestions for improving the scancode-toolkit Documentation. +title: '' +labels: 'documentation' +assignees: '' + +--- + + + +### Description + +> A brief description of the Documentation Improvement or New Section request. + + +### Link to Documentation Page + +> Where the confusion/inconsistency/incomplete documentation is. + + + +### Select Category + + +- Inconsistency [] +- New Section Request [] +- General Improvement [] +- Typo/Mistakes [] +- Other [] + + diff --git a/.github/ISSUE_TEMPLATE/--feature-request.md b/.github/ISSUE_TEMPLATE/--feature-request.md new file mode 100644 index 00000000000..722f763faec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--feature-request.md @@ -0,0 +1,56 @@ +--- +name: "\U0001F9E8 Feature request" +about: Suggest an idea for this project +title: '' +labels: new feature +assignees: '' + +--- + + + + +## Short Description + +## Possible Labels + + +- new feature + +## Select Category + + +- Enhancement [] +- Add License/Copyright [] +- Scan Feature [] +- Packaging [] +- Documentation [] +- Expand Support [] +- Other [] + +## **Describe the Update** + + + +## **How This Feature will help you/your organization** + + +## **Possible Solution/Implementation Details** + + + +## **Example/Links if Any** + + +## **Can you help with this Feature** + + + + diff --git a/.github/ISSUE_TEMPLATE/--first-timers-only.md b/.github/ISSUE_TEMPLATE/--first-timers-only.md new file mode 100644 index 00000000000..f6dea1883d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--first-timers-only.md @@ -0,0 +1,120 @@ +--- +name: "First Timers Only issue" +about: Issue based guide for new OSS contributors to solve a very easy Issue +title: '' +labels: 'first timers only' +assignees: '' + +--- + +## Introduction + +### 🤔 What you will have to Do + +You'll have to contribute to the ScanCode Toolkit Documentation, to solve inconsistensies/update +docs. + + - You'll find an issue from [here](https://github.com/nexB/scancode-toolkit/issues/1826) + - Create an issue using this template [here]() + - And then solve it (Follow the Task List Below). + +### A first-timer's Issue + +A [first-timers-only issue](https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only) +means we've worked to make it more legible to folks who either **haven't contributed to our codebase before, +or even folks who haven't contributed to open source before**. + +If that's you, we're interested in helping you take the first step and can answer questions and +help you out as you do. Note that we're especially interested in contributions from people from +groups underrepresented in free and open source software! + +We know that the process of creating a pull request is the biggest barrier for new contributors and +this issue is for you. 💝 + +If you have contributed before, **consider leaving this one for someone new**, and looking through +our general [good first issue](https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue) issues. Thanks! + +### 🤔 What you will need to know. + +Nothing. This issue is meant to welcome you to Open Source :) +You need to learn basic reStructuredText formatting, and very basic linux/git commands. +We are happy to walk you through the process. + +Useful Links - + +* [reStructuredText basics](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) +* [Git Basics](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository) + +Remember, basic help is just one Google Search away! + +### Please keep us updated + +💬⏰ - We encourage contributors to be respectful to the community and provide an update +**within a week** of claiming a first-timers-only issue. We're happy to keep it assigned to you as +long as you need if you update us with a request for more time or help, but if we don't see any +activity a week after you claim it we may reassign it to give someone else a chance. +Thank you in advance! + +If this happens to you, don't sweat it! Grab another open issue. + +### Is someone else already working on this? + +🔗- We encourage contributors to link to the original issue in their pull request so all users can +easily see if someone's already started on it. + +👥- **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/%20first%20timers%20only). +Thanks! + +### 🤔❓ Questions? + +Leave a comment below! + +## Issue + +### Issue Desription + + +### 📋 Step by Step + + +- [ ] 🙋 **Issue Claimed**: Make sure you've claimed this issue from the + [First Timers Only Issues List](https://github.com/nexB/scancode-toolkit/issues/1826) and you've been + assigned to this Issue by a maintainer. + +- [ ] **Review Guidelines** Check out our Code of Conduct and Contributing Guidelines before you start working. + +- [ ] **Refer Documentation** Refer [docuementation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_doc.html) + for more help on the contribution process and to understand our Sphinx and reStructuredText built + documentation generation better. + +- [ ] **Build Docs Locally** Fork the repository, clone it to your local system, and setup a + virtualenv to build the docs locally. + +- [ ] 📝 **Update** Fix the errors/inconsistencies. + +- [ ] **Run Test Scripts** Run the Test Scripts to make sure Docs are building successfully and are style compliant. + +- [ ] 💾 **Commit** your changes, + +- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request: + + 1. If you are familiar with the terminal or would like to learn it, + [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) + on how to send a pull request using the terminal. + + 2. You can also go to your Fork of ScanCode Toolkit and open a pull request from the branch you've pushed to. + Always create the Pull Request with the develop branch, unless otherwise instructed by maintainers. + +- [ ] 🔗 **Link the Parent Issue** Refer [Documentation]() + on creating First Timers Only Issues for more help. + +- [ ] 🏁 **Done** Ask in comments for a review :) diff --git a/.github/ISSUE_TEMPLATE/--good-first-issue.md b/.github/ISSUE_TEMPLATE/--good-first-issue.md new file mode 100644 index 00000000000..0d16927f3ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/--good-first-issue.md @@ -0,0 +1,86 @@ +--- +name: "Solving a Good First Issue" +about: Issue based guide for new contributors to solve a "Good First Issue" +title: '' +labels: 'solving good first issue' +assignees: '' + +--- + + + +A [good first issue](https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue) +means it's recommended for people who **haven't contributed to our codebase before**. +If you've solved a good first issue and want to help with more, you are welocome too! + +If that's you, we're interested in helping you take the first step and can answer questions and +help you out as you do. Note that we're especially interested in contributions from people from +groups underrepresented in free and open source software! + +We feel that the process of solving easy issues is great for new contributors, as they help in +understanding the codebase, building up confidence and get to know the Organization closely. + +Thanks for deciding to contribute and welcome to ScanCode Toolkit. 💝 + +### Please keep us updated + +💬⏰ - We encourage contributors to be respectful to the community and provide an update +**within a week** of claiming a good-first-issue. We're happy to keep it assigned to you for longer +if you update us with a request for more time or help, but if we don't see any activity a week +after you claim it we may reassign it to give someone else a chance. Thank you in advance! + +If this happens to you, don't sweat it! Grab another open issue. + +### Is someone else already working on this? + +🔗- We encourage contributors to link to the original issue in their pull request so all users can +easily see if someone's already started on it. + +👥- **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! + +### 📋 Step by Step + + +- [ ] 🙋 **Claim this issue**: Make sure you've already claimed this issue from the + [Good First Issues List](https://github.com/nexB/scancode-toolkit/issues/1825) and you've been + assigned to this Issue by a maintainer. You should have your name beside the issue, + in the list, added by a maintainer. + +- [ ] **Reproduce** Try to reproduce the problem in the most minimal way with a command line + invocation of scancode as outlined above, trying to find a few files that make this fail. + +- [ ] **Create a Unit test** Once you have a minimally reproducible problem, create a unit test + (that is failing for now) that reproduces the problem. Assert the things that should be there + in the results. + +- [ ] **Come up with a Solution** Look at the failure trace and try to understand why this is not + working and which places the code may need fixing. + +- [ ] 📝 **Code your Solution** + +- [ ] 📝 **Run the tests locally** + Refer [Documentation](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests) + +- [ ] 💾 **Commit and Push** your changes. Do check out this documentation on + [writing good commit messages](https://aboutcode.readthedocs.io/en/latest/aboutcode-docs/writing_good_commit_messages.html) + +- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request: + + 1. If you are familiar with the terminal or would like to learn it, + [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) + on how to send a pull request using the terminal. + + 2. You can also go to your Fork of ScanCode Toolkit and open a pull request from the branch you've pushed to. + Always create the Pull Request with the develop branch, unless otherwise instructed by maintainers. + +- [ ] Make Sure all the Tests Pass + +- [ ] 🏁 **Done** Ask in comments for a review :) + +### 🤔❓ Questions? + +Leave a comment below! diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..f2c2475a5a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..93be8cd1ece --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Gitter Chat + url: https://gitter.im/aboutcode-org/discuss + about: Please ask questions here. + - name: Code Of Conduct + url: https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst + about: This space is protected by our Code Of Conduct. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..b0904fce5f4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ + + + + +Fixes #0000 + + + +### Tasks + +* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst) +* [ ] PR is descriptively titled 📑 and links the original issue above 🔗 +* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR + Run [tests](https://aboutcode.readthedocs.io/en/latest/scancode-toolkit/contribute/contrib_dev.html#running-tests) locally to check for errors. +* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁 + + + + diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 00000000000..331e3ab4ffe --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,25 @@ +# Configuration for welcome - https://github.com/behaviorbot/welcome + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome + +# Comment to be posted to on first time issues +newIssueWelcomeComment: | + Thanks for opening your first issue! 👍🎉😄⚡️ + This space is protected by our [Code of Conduct](https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst) - and we're here to help. + Do join our [Gitter channel](https://gitter.im/aboutcode-org/discuss) for more discussions. +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome + +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: | + Thanks for opening this pull request! 👍🎉😄⚡️ + This space is protected by our [Code of Conduct](https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst) - and we're here to help. + Also please refer [Contributing related documentation](https://scancode-toolkit.readthedocs.io/en/latest/contribute/) for more help! 💿 + +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: | + Congrats on merging your first pull request! 👍🎉😄⚡️ + Now that you've completed this, you can help on more [Good First Issues](https://github.com/nexB/scancode-toolkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) + +# It is recommend to include as many gifs and emojis as possible diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 31285c6e6d8..00000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,9 +0,0 @@ -### Description -Please leave a brief description of the bug or feature request: -* if reporting a bug, tell us how to reproduce the issue. - -### System configuration -For bug reports, it really helps us to know: -* What OS are you running on? (Windows/MacOS/Linux) -* What version of scancode-toolkit was used to generate the scan file? -* What installation method was used to install/run scancode? (pip/source download/other)