Add 2024 GSoC report Compute Summary for all detected packages #143
Conversation
Signed-off-by: swastik <[email protected]>
Signed-off-by: swastik <[email protected]>
Signed-off-by: swastik <[email protected]>
There was a problem hiding this comment.
A few more changes and this will start to look good. Thanks!
For some reason the build is not showing up, linking it here: https://aboutcode--143.org.readthedocs.build/en/143/archive/gsoc/reports/2024/scancode_toolkit_swastkk.html
Also please fix the doc tests from the CI.
docs/source/archive/gsoc/reports/2024/scancode_toolkit_swastkk.rst
Outdated
Show resolved
Hide resolved
docs/source/archive/gsoc/reports/2024/scancode_toolkit_swastkk.rst
Outdated
Show resolved
Hide resolved
docs/source/archive/gsoc/reports/2024/scancode_toolkit_swastkk.rst
Outdated
Show resolved
Hide resolved
docs/source/archive/gsoc/reports/2024/scancode_toolkit_swastkk.rst
Outdated
Show resolved
Hide resolved
| -------------- | ||
|
|
||
| All the work I did is contained in `this single PR <https://github.com/aboutcode-org/scancode-toolkit/pull/3792>`_. | ||
| I added a new command-line option called ``--package-summary`` that users can employ to obtain |
There was a problem hiding this comment.
We need to have unordered lists here, with a bit more details, use the points in the timeline from your proposal.
There was a problem hiding this comment.
Add issue links for specific items if they exist. Create issues and ask me to populate the project board as necessary.
|
|
||
| This change allows users to get the more refined summary for each individual package | ||
| that is present in a codebase. Also this feature improves the package assembly for | ||
| various package ecosystems like npm, python-whl, rust, rubygems etc. |
There was a problem hiding this comment.
This needs to be a bit more detailed, and in an unordered list.
| various package ecosystems like npm, python-whl, rust, rubygems etc. | ||
|
|
||
|
|
||
| Finally, all these changes are tested through multiple unit tests validating both correct |
There was a problem hiding this comment.
You haven't added any unit tests in aboutcode-org/scancode-toolkit#3792 unit tests means tests for a single function, you have added only full scan tests, and have to add unit tests before the PR can be merged. Let's only mention whatever work was completed and move things like this to a section called remaining work/post gsoc. We can always update this page after the work is done.
Signed-off-by: swastik <[email protected]>
Signed-off-by: swastik <[email protected]>
Signed-off-by: swastik <[email protected]>
There was a problem hiding this comment.
@swastkk Thanks! Looks good for now, we need to update this post-GSoC another time with more details and updates though.
Yes, will update this page with more details & updates. |
Add the GSoC 2024 project
Compute Summary for all detected packagesby swastkkSigned-off-by: Swastik Sharma [email protected]
Tasks
Run tests locally to check for errors.