Merged
Conversation
To mitigate Scorecard SecurityPolicyID rule violation.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces new documentation files to improve contributor guidelines and clarify the project's security policy. It adds SECURITY.md and CONTRIBUTING.md files while updating the README.md to reference the new contributing guidelines and improve language clarity.
- Added SECURITY.md outlining disclosure processes and response timelines.
- Added CONTRIBUTING.md with detailed contribution and code change guidelines.
- Updated README.md for improved clarity and consistency in installation and testing instructions.
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| SECURITY.md | New security policy documentation outlining disclosure methods. |
| README.md | Updates to installation instructions, algorithm categorization, and pointer to CONTRIBUTING.md. |
| CONTRIBUTING.md | New contributor guidelines and detailed instructions for adding new sorting algorithms. |
Comments suppressed due to low confidence (3)
SECURITY.md:7
- Consider including a brief note on an escalation process or alternative contact method for urgent vulnerability reports, to guide users when the 90-day response timeline may not be sufficient.
Due to limited contributor pool and resources, addressing reported vulnerabilities may take up to 90 days.
README.md:15
- [nitpick] Consider rephrasing the bullet to a more neutral tone, such as 'Algorithms with high time complexity', to avoid subjective or potentially negative language.
- impractical due to poor time complexity:
CONTRIBUTING.md:73
- [nitpick] Clarify in a comment that placeholders like '{Algorithm}' should be replaced with the actual algorithm name to avoid confusion for contributors.
func {Algorithm}[T constraints.Ordered](ctx context.Context, data []T) error {
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.
Introduces:
CONTRIBUTING.mdandSECURITY.mdfiles.