Enhance README with ScanCode Action details#31
Open
divyanshrai1 wants to merge 1 commit intoaboutcode-org:mainfrom
Open
Enhance README with ScanCode Action details#31divyanshrai1 wants to merge 1 commit intoaboutcode-org:mainfrom
divyanshrai1 wants to merge 1 commit intoaboutcode-org:mainfrom
Conversation
Added detailed sections about ScanCode Action usage and results interpretation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses issue #12 by adding a comprehensive "Understanding ScanCode Action" section to the README.
Changes Made
Added New Section: "Understanding ScanCode Action"
This section includes:
check-complianceto fail builds on policy violationsUpdated Table of Contents
Motivation
As mentioned in #12, users were confused about what "build passed" means and how to interpret scan results. This documentation makes it clear that:
Testing
Looking forward to your feedback! This is my first contribution to open source, so please let me know if any changes are needed.