Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions .github/ISSUE_TEMPLATE/--feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ about: Suggest an idea for this project
title: ''
labels: new feature
assignees: ''

---

<!-- Please fill out as much of the template as you can. Delete sections if unneccesary -->

<!--
Make Sure you've checked out
Existing Issues,
Expand All @@ -18,39 +17,43 @@ Make Sure you've checked out
## Short Description

## Possible Labels

<!-- What labels can be assigned - https://github.com/nexB/scancode-toolkit/labels -->

- new feature

## Select Category

<!-- Which of this label correctly describe your feature Request -->

- [ ] Enhancement
- [ ] Add License/Copyright
- [ ] Scan Feature
- [ ] Packaging
- [ ] Documentation
- [ ] Expand Support
- [ ] Other
- [ ] Enhancement
- [ ] Add License/Copyright
- [ ] Scan Feature
- [ ] Packaging
- [ ] Documentation
- [ ] Expand Support
- [ ] Other

## **Describe the Update**
<!-- What feature is requested. -->

<!-- What feature is requested. -->

## **How This Feature will help you/your organization**


## **Possible Solution/Implementation Details**
<!-- Describe the solution you'd like. -->

<!-- Describe the solution you'd like. -->

## **Example/Links if Any**

<!-- Link to already similar features across other OSS -->

## **Can you help with this Feature**

<!-- Pull Requests are much Appreciated -->

<!-- End. -->

<!--
Thank you! Your help makes ScanCode Toolkit better. We *deeply* appreciate it.
-->
52 changes: 19 additions & 33 deletions .github/ISSUE_TEMPLATE/--lic-det-bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ about: Create a Report for a License Detection Bug
title: ''
labels: 'bug', 'license scan', 'new and improved data'
assignees: ''

---

<!--
Please fill out as much of the below template and delete unnecessary text.
Sample License Detection Bug Reports
Expand All @@ -19,75 +17,63 @@ Markdown Styling - https://commonmark.org/help/

> Please leave a brief description of the License Detection Bug:


### Where to get the File/Package

> Link to Public Repository/Package Index, if there are multiple files that has license detection errors
> Also list some example files. If the bug is in a single file then link to the file.


> Also list some example files. If the bug is in a single file then link to the file.

## Scan Reports
## Scan Reports

> What scancode command was used?


> Scan Outputs (Preferably of a whole file in [json-pretty-print](https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/output-format.html#json-pp-file))
> Note:-
> If possible please use the `--license-text` and `--license-text-diagonostics` [command line options](https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/basic-options.html#license-text-diagnostics-options)
> Note:-
> If possible please use the `--license-text` and `--license-text-diagonostics` [command line options](https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/basic-options.html#license-text-diagnostics-options)
> as it helps understand which parts were wrongly matched and gives us more insight into the bug
> Upload your results.json file on this issue [like this](https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests)



### System/Scancode Configuration

> For bug reports, it really helps us to know:

* What OS are you running on?
> (Windows/MacOS/Linux)
* What OS are you running on?

> (Windows/MacOS/Linux)

* What version of scancode-toolkit was used to generate the scan file?
> `./scancode --version`

> `./scancode --version`

* What installation method was used to install/run scancode?
> (pip/source download/other)
* What installation method was used to install/run scancode?

> (pip/source download/other)

## Links to Rule or excerpts of Rule Texts (If Possible)

> Which Licenses/Rules were wrongly matched (if Applicable)
>
>
> [Rule Directory](https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/rules) and [License Directory](https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses)



## Select the Relevant Issue Category(s)

> [ ] - Unselected, [x] - Selected

- [ ] Unknown License
- [ ] False Positive
- [ ] Multiple Detections, Some Wrong
- [ ] License Version Mismatch
- [ ] New License
- [ ] Change in License/Rule Attributes
- [ ] Edit existing Rule
- [ ] From [`scancode-results-analyzer`](https://github.com/nexB/scancode-results-analyzer)

- [ ] Unknown License
- [ ] False Positive
- [ ] Multiple Detections, Some Wrong
- [ ] License Version Mismatch
- [ ] New License
- [ ] Change in License/Rule Attributes
- [ ] Edit existing Rule
- [ ] From [`scancode-results-analyzer`](https://github.com/nexB/scancode-results-analyzer)

## Comments on the License Detection Bug

> What should have been detected instead, why is it a bug.



## Comments (if any) on How to Add a New Rule/Modify an existing Rule for solving this Bug

> Refer the documentation page at [Add new license](https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/add_new_license.html) and [Add new rule](https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/add_new_license_detection_rule.html)

> Refer the documentation page at [Add new license](https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/add_new_license.html) and [Add new rule](https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/add_new_license_detection_rule.html)

<!--
Your help makes ScanCode Toolkit better! We *deeply* appreciate your help in improving ScanCode Toolkit.
Expand Down
5 changes: 4 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Delete Template sections if unneccesary -->

<!-- Add issue number here (We encourage you to create the Issue First) -->

<!-- You can also link the issue in Commit Messages -->

Fixes #0000
Expand All @@ -15,10 +17,11 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r
* [ ] 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://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests) locally to check for errors.
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 📁
* [ ] Updated documentation pages (if applicable)
* [ ] Updated CHANGELOG.rst (if applicable)

<!--
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
if your tests fail at first!
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Build and tests status
======================

We run 30,000+ tests on each commit on multiple CIs to ensure a good platform
compabitility with multiple versions of Windows, Linux and macOS.
compatibility with multiple versions of Windows, Linux and macOS.

+------------+--------------+-------------------------+----------------------------+
| **Azure** | **RTD Build**| **GitHub actions Docs** | **GitHub actions Release** |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ and other options.

.. note::

Add rules in a local developement installation and run `scancode-reindex-licenses`
Add rules in a local development installation and run `scancode-reindex-licenses`
to make sure we reindex the rules and this validates the new licenses.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _how-to-install-new-license-plugin:

How to install external licenses to use in license dectection
How to install external licenses to use in license detection
=============================================================

Users can install external licenses and rules in the form of:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/reference/scancode-cli/cli-basic-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ Quick reference
``--email``
-----------

The ``--email`` option detects and reports email adresses present in scanned files.
The ``--email`` option detects and reports email addresses present in scanned files.

It adds the ``emails`` attribute to the file data with the following attributes:
``email`` with the actual email that was present in the file, ``start_line`` and
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorials/adding-a-post-scan-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Here are the major types of plugins:

2. Scan plugins (`scancode_scan` in entry points)

The are the scancode plugins which does the file scanning for useful
These are the scancode plugins which does the file scanning for useful
information like license, copyrights, packages and others. These are
run on multiprocessing for speed as they are done on a per-file basis,
but there can also be post-processing steps on these which are run afterwards
Expand All @@ -30,7 +30,7 @@ Here are the major types of plugins:

3. Post-scan plugins (`scancode_post_scan` in entry points)

These are mainly data processing, summerizing and reporting plugins which
These are mainly data processing, summarizing and reporting plugins which
depend on all the results for the scan plugins. These add new codebase level
or file-level attributes, and even removes/modifies data as required
for consolidation or summarization. The base plugin class to be extended is ``PostScanPlugin``
Expand Down
Loading