Skip to content

Improve docs#108

Merged
macie merged 2 commits intodevfrom
docs_improvements
Jun 18, 2025
Merged

Improve docs#108
macie merged 2 commits intodevfrom
docs_improvements

Conversation

@macie
Copy link
Owner

@macie macie commented Jun 18, 2025

Introduces: CONTRIBUTING.md and SECURITY.md files.

@macie macie requested a review from Copilot June 18, 2025 19:56

This comment was marked as outdated.

macie added 2 commits June 18, 2025 22:12
To mitigate Scorecard SecurityPolicyID rule violation.
@macie macie force-pushed the docs_improvements branch from cca93d9 to bf1f7f3 Compare June 18, 2025 20:12
@macie macie requested a review from Copilot June 18, 2025 20:13
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 {

@macie macie merged commit bf1f7f3 into dev Jun 18, 2025
10 checks passed
@macie macie deleted the docs_improvements branch June 18, 2025 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants