From 78a64e5348f0bca0cb0fa5ead20ae4e4e16e5766 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Mon, 10 Jul 2023 15:17:09 +0530 Subject: [PATCH 1/9] Update github actions Reference: https://github.com/nexB/skeleton/issues/75 Signed-off-by: Ayan Sinha Mahapatra --- .github/workflows/pypi-release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml index 4ebe10d1406..958573010c5 100644 --- a/.github/workflows/pypi-release.yml +++ b/.github/workflows/pypi-release.yml @@ -78,6 +78,6 @@ jobs: - name: Publish to PyPI if: startsWith(github.ref, 'refs/tags') - uses: pypa/gh-action-pypi-publish@master + uses: pypa/gh-action-pypi-publish@release/v1 with: password: ${{ secrets.PYPI_API_TOKEN }} From a4d8628e1fc3c956f28ac8104e2d895bfad7f592 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Mon, 10 Jul 2023 15:22:22 +0530 Subject: [PATCH 2/9] Update RTD buil Signed-off-by: Ayan Sinha Mahapatra --- .readthedocs.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2a7dc0b40d1..8ab23688c75 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,6 +5,12 @@ # Required version: 2 +# Build in latest ubuntu/python +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # Build PDF & ePub formats: - epub From 4c68fba913f5ebd7598200e14b8085e5d38865a2 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Mon, 10 Jul 2023 15:34:19 +0530 Subject: [PATCH 3/9] Fix unordered lists issue Signed-off-by: Ayan Sinha Mahapatra --- setup.cfg | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.cfg b/setup.cfg index b02fd346365..ae1043ee242 100644 --- a/setup.cfg +++ b/setup.cfg @@ -58,6 +58,6 @@ testing = isort docs = - Sphinx == 5.1.0 - sphinx-rtd-theme >= 0.5.0 - doc8 >= 0.8.1 + Sphinx>=5.0.2 + sphinx-rtd-theme>=1.0.0 + doc8>=0.11.2 \ No newline at end of file From c33241d5f0407f740e0a49280ffc65a60f1ab247 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Thu, 25 May 2023 23:25:58 +0530 Subject: [PATCH 4/9] Add redirects for docs Signed-off-by: Ayan Sinha Mahapatra --- docs/source/conf.py | 6 ++++++ setup.cfg | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 39835c69400..918d62c1150 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,8 +29,14 @@ # ones. extensions = [ "sphinx.ext.intersphinx", + "sphinx_reredirects", ] + +# Redirects for olds pages +# See https://documatt.gitlab.io/sphinx-reredirects/usage.html +redirects = {} + # This points to aboutcode.readthedocs.io # In case of "undefined label" ERRORS check docs on intersphinx to troubleshoot # Link was created at commit - https://github.com/nexB/aboutcode/commit/faea9fcf3248f8f198844fe34d43833224ac4a83 diff --git a/setup.cfg b/setup.cfg index ae1043ee242..d6c7da7d1ee 100644 --- a/setup.cfg +++ b/setup.cfg @@ -60,4 +60,6 @@ testing = docs = Sphinx>=5.0.2 sphinx-rtd-theme>=1.0.0 - doc8>=0.11.2 \ No newline at end of file + sphinx-reredirects >= 0.1.2 + doc8>=0.11.2 + From 8c042228dbd0f2f8e61852e7fb60e848d9dd4371 Mon Sep 17 00:00:00 2001 From: Jono Yang Date: Tue, 18 Jul 2023 10:05:03 -0700 Subject: [PATCH 5/9] Add macOS-13 job in azure-pipelines.yml Signed-off-by: Jono Yang --- README.rst | 5 ++++- azure-pipelines.yml | 12 ++++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index be6573425cf..6cbd8395fcf 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ A Simple Python Project Skeleton ================================ This repo attempts to standardize the structure of the Python-based project's -repositories using modern Python packaging and configuration techniques. +repositories using modern Python packaging and configuration techniques. Using this `blog post`_ as inspiration, this repository serves as the base for all new Python projects and is mergeable in existing repositories as well. @@ -41,6 +41,9 @@ More usage instructions can be found in ``docs/skeleton-usage.rst``. Release Notes ============= +- 2023-07-18: + - Add macOS-13 job in azure-pipelines.yml + - 2022-03-04: - Synchronize configure and configure.bat scripts for sanity - Update CI operating system support with latest Azure OS images diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 5067fd450d0..764883deb6b 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -26,7 +26,7 @@ jobs: - template: etc/ci/azure-posix.yml parameters: job_name: macos11_cpython - image_name: macos-11 + image_name: macOS-11 python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11'] test_suites: all: venv/bin/pytest -n 2 -vvs @@ -34,7 +34,15 @@ jobs: - template: etc/ci/azure-posix.yml parameters: job_name: macos12_cpython - image_name: macos-12 + image_name: macOS-12 + python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11'] + test_suites: + all: venv/bin/pytest -n 2 -vvs + + - template: etc/ci/azure-posix.yml + parameters: + job_name: macos13_cpython + image_name: macOS-13 python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11'] test_suites: all: venv/bin/pytest -n 2 -vvs From 5ab9b3a15e0095a8186ca3870cb9f9eade83833d Mon Sep 17 00:00:00 2001 From: Omkar Phansopkar Date: Wed, 18 Oct 2023 15:42:56 +0530 Subject: [PATCH 6/9] Added docs server script, dark mode & copybutton for docs Signed-off-by: Omkar Phansopkar --- .github/workflows/docs-ci.yml | 3 --- docs/Makefile | 8 ++++++++ docs/make.bat | 12 ++++++++++++ docs/scripts/doc8_style_check.sh | 0 docs/source/conf.py | 4 ++++ setup.cfg | 3 +++ 6 files changed, 27 insertions(+), 3 deletions(-) mode change 100644 => 100755 docs/scripts/doc8_style_check.sh diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml index 511b7c283a6..ada779bfcbf 100644 --- a/.github/workflows/docs-ci.yml +++ b/.github/workflows/docs-ci.yml @@ -20,9 +20,6 @@ jobs: with: python-version: ${{ matrix.python-version }} - - name: Give permission to run scripts - run: chmod +x ./docs/scripts/doc8_style_check.sh - - name: Install Dependencies run: pip install -e .[docs] diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf1020..788b0396195 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,6 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build +SPHINXAUTOBUILD = sphinx-autobuild SOURCEDIR = source BUILDDIR = build @@ -14,6 +15,13 @@ help: .PHONY: help Makefile +# Run the development server using sphinx-autobuild +docs: + @echo + @echo "Starting up the docs server..." + @echo + $(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O) + # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile diff --git a/docs/make.bat b/docs/make.bat index 6247f7e2317..4a3c1a48527 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,11 +7,16 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) +if "%SPHINXAUTOBUILD%" == "" ( + set SPHINXAUTOBUILD=sphinx-autobuild +) set SOURCEDIR=source set BUILDDIR=build if "%1" == "" goto help +if "%1" == "docs" goto docs + %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. @@ -28,6 +33,13 @@ if errorlevel 9009 ( %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end +:docs +@echo +@echo Starting up the docs server... +@echo +%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O% +goto end + :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% diff --git a/docs/scripts/doc8_style_check.sh b/docs/scripts/doc8_style_check.sh old mode 100644 new mode 100755 diff --git a/docs/source/conf.py b/docs/source/conf.py index 918d62c1150..54e5e665a36 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -30,6 +30,10 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx_reredirects", + 'sphinx_rtd_theme', + "sphinx_rtd_dark_mode", + "sphinx.ext.extlinks", + "sphinx_copybutton", ] diff --git a/setup.cfg b/setup.cfg index d6c7da7d1ee..bd0e58a705c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -62,4 +62,7 @@ docs = sphinx-rtd-theme>=1.0.0 sphinx-reredirects >= 0.1.2 doc8>=0.11.2 + sphinx-autobuild + sphinx-rtd-dark-mode>=1.3.0 + sphinx-copybutton From d6cb74f82f2a42952c5d247c6da812c6632f1a92 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Thu, 11 Jan 2024 19:54:37 +0530 Subject: [PATCH 7/9] Fix broken links in SCTK docs Signed-off-by: Ayan Sinha Mahapatra --- docs/source/cli-reference/basic-options.rst | 14 +++++++------- docs/source/conf.py | 6 ++++++ docs/source/contribute/contrib_dev.rst | 2 +- docs/source/contribute/contrib_doc.rst | 2 +- docs/source/contribute/gsoc21_final_report.rst | 2 +- docs/source/how-to-guides/add_new_license.rst | 2 +- .../source/reference/available_package_parsers.rst | 4 ++-- .../reference/license-detection-reference.rst | 6 +++--- src/packagedcode/pypi.py | 2 +- 9 files changed, 23 insertions(+), 17 deletions(-) diff --git a/docs/source/cli-reference/basic-options.rst b/docs/source/cli-reference/basic-options.rst index 69d7a4bbb4c..19240944b75 100644 --- a/docs/source/cli-reference/basic-options.rst +++ b/docs/source/cli-reference/basic-options.rst @@ -580,26 +580,26 @@ The ``--license-url-template`` option sets the template URL used for the license reference URLs. - The default template URL is : [https://enterprise.dejacode.com/urn/urn:dje:license:{}] + The default template URL is : [https://scancode-licensedb.aboutcode.org/{}] In a template URL, curly braces ({}) are replaced by the license key. - So, by default the license reference URL points to the dejacode page for that license. + So, by default the license reference URL points to the LicenseDB page for that license. A scan example using the ``--license-url-template TEXT`` option :: - scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.yml + scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE In a normal scan, reference url for "ZLIB License" is as follows:: - "reference_url": "https://enterprise.dejacode.com/urn/urn:dje:license:zlib", + "reference_url": "https://scancode-licensedb.aboutcode.org/zlib", After using the option in the following manner:: - ``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}`` + ``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE`` - the reference URL changes to this `zlib.yml file `_:: + the reference URL changes to this `zlib.LICENSE file `_:: - "reference_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/zlib.yml", + "reference_url": "https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE", The reference URL changes for all detected licenses in the scan, across the scan result file. diff --git a/docs/source/conf.py b/docs/source/conf.py index f4e4527eb99..0ef27a86006 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,6 +54,12 @@ "scancode-workbench": ("https://scancode-workbench.readthedocs.io/en/latest/", None), } +# List of regular expressions for the linkchecker to ignore +# See https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder +linkcheck_ignore = [ + r'https://en.wikipedia.org/wiki/*', + r'https://matrix.to/*' +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/contribute/contrib_dev.rst b/docs/source/contribute/contrib_dev.rst index 082e34d79ab..2498bba26b7 100644 --- a/docs/source/contribute/contrib_dev.rst +++ b/docs/source/contribute/contrib_dev.rst @@ -82,7 +82,7 @@ If you have a multiprocessor machine you might want to run the tests in parallel typically run the tests in verbose mode with ``pytest -vvs -n4``. You can also run a subset of the test suite as shown in the CI configs -https://github.com/nexB/scancode-toolkit/blob/develop/appveyor.yml#L6 e,g, +https://github.com/nexB/scancode-toolkit/blob/develop/azure-pipelines.yml e,g, ``pytest -n 2 -vvs tests/scancode`` runs only the test scripts present in the ``tests/scancode`` directory. (You can give the path to a specific test script file there too). diff --git a/docs/source/contribute/contrib_doc.rst b/docs/source/contribute/contrib_doc.rst index 132ee8314c2..530f159b9f4 100644 --- a/docs/source/contribute/contrib_doc.rst +++ b/docs/source/contribute/contrib_doc.rst @@ -173,7 +173,7 @@ ScanCode toolkit documentation uses `Intersphinx `_ for more information. +`Cross-Referencing `_ for more information. For example:: diff --git a/docs/source/contribute/gsoc21_final_report.rst b/docs/source/contribute/gsoc21_final_report.rst index ecc2b543a82..2d4da89dd64 100644 --- a/docs/source/contribute/gsoc21_final_report.rst +++ b/docs/source/contribute/gsoc21_final_report.rst @@ -15,7 +15,7 @@ Project: Detect Unknown Licenses and Indirect License References in Scancode `ScanCode-toolkit `_ -`Project Link `_ +`Project Link `_ `Proposal `_ diff --git a/docs/source/how-to-guides/add_new_license.rst b/docs/source/how-to-guides/add_new_license.rst index 15b925665d2..b4db99f96e7 100644 --- a/docs/source/how-to-guides/add_new_license.rst +++ b/docs/source/how-to-guides/add_new_license.rst @@ -31,7 +31,7 @@ You need to create a file with: text as is, with the original formatting intact. - the data attributes for the license in YAML format as - `YAML frontmatter `_. + `YAML frontmatter `_. See an example license: `apache-2.0.LICENSE `_ diff --git a/docs/source/reference/available_package_parsers.rst b/docs/source/reference/available_package_parsers.rst index 86954ef68a0..ecea9aa5b7c 100644 --- a/docs/source/reference/available_package_parsers.rst +++ b/docs/source/reference/available_package_parsers.rst @@ -646,7 +646,7 @@ parsers in scancode-toolkit during documentation builds. - ``pypi`` - ``pypi_setup_py`` - Python - - https://docs.python.org/3/distutils/setupscript.html + - https://docs.python.org/3.11/distutils/setupscript.html * - PyPI wheel - ``*.whl`` - ``pypi`` @@ -692,7 +692,7 @@ parsers in scancode-toolkit during documentation builds. - None - https://fedoraproject.org/wiki/Changes/NewRpmDBFormat * - RPM installed package SQLite database - - ``*var/lib/rpm/rpmdb.sqlite`` + - ``*rpm/rpmdb.sqlite`` - ``rpm`` - ``rpm_installed_database_sqlite`` - None diff --git a/docs/source/reference/license-detection-reference.rst b/docs/source/reference/license-detection-reference.rst index 62bbbe65ec3..e7db1416816 100644 --- a/docs/source/reference/license-detection-reference.rst +++ b/docs/source/reference/license-detection-reference.rst @@ -299,7 +299,7 @@ also has been renamed to ``extracted_license_statement``. .. _license_detections_unique: -New codebase level Unique License Detection +Codebase level Unique License Detection ------------------------------------------- We now have a new codebase level attribute ``license_detections`` which has Unique @@ -688,8 +688,8 @@ LicenseDetection Data This is referencing by LicenseDetections objects, and has one or multiple license matches. This is linked to the resource level detections through an ``identifier`` attribute present in both resource and codebase level -detections. See the `unique license detections section `_ -above for more details on this. +detections. See the :ref:`license_detections_unique` above for more +details on this. There could be a list of ambiguous detections as a summary to review. This is WIP, see `scancode-toolkit#3122 `_. diff --git a/src/packagedcode/pypi.py b/src/packagedcode/pypi.py index 79fb78f49b8..d90dacbabef 100644 --- a/src/packagedcode/pypi.py +++ b/src/packagedcode/pypi.py @@ -643,7 +643,7 @@ class PythonSetupPyHandler(BaseExtractedPythonLayout): default_package_type = 'pypi' default_primary_language = 'Python' description = 'Python setup.py' - documentation_url = 'https://docs.python.org/3/distutils/setupscript.html' + documentation_url = 'https://docs.python.org/3.11/distutils/setupscript.html' @classmethod def parse(cls, location): From 8d2abc5a1dde5a3404f177985277b5dc813067ed Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Thu, 11 Jan 2024 20:13:17 +0530 Subject: [PATCH 8/9] Fix unordered list bug Signed-off-by: Ayan Sinha Mahapatra --- setup.cfg | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.cfg b/setup.cfg index 7ec3b850783..5f4bc343465 100644 --- a/setup.cfg +++ b/setup.cfg @@ -137,10 +137,10 @@ testing = pytest-rerunfailures docs = - Sphinx>=5.0.2 - sphinx-rtd-theme>=1.0.0 + Sphinx == 5.1.0 + sphinx-rtd-theme >= 0.5.0 + doc8 >= 0.8.1 sphinx-reredirects >= 0.1.2 - doc8>=0.11.2 sphinx-autobuild sphinx-rtd-dark-mode>=1.3.0 sphinx-copybutton From 239e13d290b33a991309ce5ae294caeaaf879aab Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Thu, 11 Jan 2024 20:39:51 +0530 Subject: [PATCH 9/9] Misc config updates Signed-off-by: Ayan Sinha Mahapatra --- .cirrus.yml | 20 --- .coveragerc | 34 ----- .github/ISSUE_TEMPLATE/--first-timers-only.md | 120 ------------------ .github/ISSUE_TEMPLATE/--good-first-issue.md | 86 ------------- .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/PULL_REQUEST_TEMPLATE.md | 4 +- appveyor.yml | 19 --- configure | 2 +- configure.bat | 2 +- tests/packagedcode/data/plugin/help.txt | 2 +- 10 files changed, 8 insertions(+), 287 deletions(-) delete mode 100644 .cirrus.yml delete mode 100644 .coveragerc delete mode 100644 .github/ISSUE_TEMPLATE/--first-timers-only.md delete mode 100644 .github/ISSUE_TEMPLATE/--good-first-issue.md delete mode 100644 appveyor.yml 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)