diff --git a/.cirrus.yml b/.cirrus.yml deleted file mode 100644 index 553eea5de92..00000000000 --- a/.cirrus.yml +++ /dev/null @@ -1,20 +0,0 @@ -env: - CIRRUS_CLONE_DEPTH: 1 - ARCH: amd64 - -py36_task: - env: - PYTHON_EXE: /usr/local/bin/python3.8 - - freebsd_instance: - matrix: - image: freebsd-11-2-release-amd64 - image: freebsd-12-0-release-amd64 - - install_script: - - sed -i.bak -e 's,pkg+http://pkg.FreeBSD.org/\${ABI}/quarterly,pkg+http://pkg.FreeBSD.org/\${ABI}/latest,' /etc/pkg/FreeBSD.conf - - pkg upgrade -y - - pkg install -y python38 bash libxml2 libxslt - - script: - - ./configure diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index eea1f246a63..00000000000 --- a/.coveragerc +++ /dev/null @@ -1,34 +0,0 @@ -# .coveragerc to control coverage.py -[coverage:run] -branch = True -omit = - # no config, tests, samples, data or bin directory and related files - tests/* - samples/* - thirdparty/* - etc/* - */data/* - */bin/* - */templates/* - src/scancode/cli_test_utils.py - src/scancode_config.py - # ignore specific third-party code which is not tested here, but elsewhere - src/commoncode/dict_utils.py - -[coverage:report] -# lines to exclude from consideration -exclude_lines = - # Have to re-enable the standard pragma - pragma: no cover - - # Debug-only code: - def __repr__ - if TRACE - logger - - # Some assertion code: - raise AssertionError - raise NotImplementedError - - # main code does not run in our context: - if __name__ == .__main__.: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/--first-timers-only.md b/.github/ISSUE_TEMPLATE/--first-timers-only.md deleted file mode 100644 index 20a2057f0ed..00000000000 --- a/.github/ISSUE_TEMPLATE/--first-timers-only.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -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/first%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://scancode-toolkit.readthedocs.io/en/latest/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 deleted file mode 100644 index 5b30e4e8801..00000000000 --- a/.github/ISSUE_TEMPLATE/--good-first-issue.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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://scancode-toolkit.readthedocs.io/en/latest/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/coding-principles/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/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 93be8cd1ece..d010cf17cfe 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: true contact_links: - - name: Gitter Chat - url: https://gitter.im/aboutcode-org/discuss + - name: Matrix Chat + url: https://matrix.to/#/#aboutcode-org_discuss:gitter.im 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 + 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 index 5716601d8eb..91291b65a52 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,8 +17,8 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r * [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR Run [tests](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests) locally to check for errors. * [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁 -* [ ] Looked for possible updates in documentation and added updates if applicable -* [ ] Updated CHANGELOG.rst +* [ ] Updated documentation pages (if applicable) +* [ ] Updated CHANGELOG.rst (if applicable)