docs(contributing): add CONTRIBUTING.md with guidelines for contributors #571
Conversation
WalkthroughThis change introduces a new Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
|
|
||
| ### Reporting Bugs | ||
|
|
||
| If you find a bug, please report it by opening a [GitHub issue](https://github.com/pyupio/safety/issues). When reporting a bug, please include: |
There was a problem hiding this comment.
Is it worth linking to our bug bounty page?
There was a problem hiding this comment.
For sure! I just added that in!
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
CONTRIBUTING.md (4)
3-3: Consider rephrasing for clarity.The phrase "grateful for your help in making SafetyCLI better" could be improved for style. Consider rephrasing to: "grateful for your contributions to improving SafetyCLI."
- We welcome contributions from everyone and are grateful for your help in making SafetyCLI better. + We welcome contributions from everyone and are grateful for your contributions to improving SafetyCLI.Tools
LanguageTool
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
34-34: Remove loose punctuation.There is a loose punctuation mark after "Critical". Consider removing it for consistency.
- `Critical`: Issues that break core functionality or pose significant security vulnerabilities. + `Critical`: Issues that break core functionality or pose significant security vulnerabilitiesTools
LanguageTool
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
35-35: Remove loose punctuation.There is a loose punctuation mark after "Low". Consider removing it for consistency.
- `High`, `Medium`, `Low`: Significance of bugs affecting users. + `High`, `Medium`, `Low`: Significance of bugs affecting usersTools
LanguageTool
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
69-69: Remove multiple spaces after hash in heading.There are multiple spaces after the hash in the "Development Setup" heading. Consider removing the extra spaces.
- ### Development Setup + ### Development SetupTools
Markdownlint
69-69: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...other contributors. -good first issue: Highlights issues that are suitable for...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
CONTRIBUTING.md
69-69: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
Additional comments not posted (4)
CONTRIBUTING.md (4)
5-20: Table of Contents is well-structured.The table of contents is comprehensive and aids in easy navigation through the document.
21-62: Contribution guidelines are clear and informative.The guidelines for reporting bugs, suggesting enhancements, and improving documentation are well-structured and clear.
Tools
LanguageTool
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...other contributors. -good first issue: Highlights issues that are suitable for...(UNLIKELY_OPENING_PUNCTUATION)
63-87: Getting Started section is clear and helpful.The instructions for setting up the development environment and running tests are clear and helpful.
Tools
Markdownlint
69-69: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
88-109: Pull Request Process and License sections are well-defined.The guidelines for commit messages, merging changes, and licensing are clear and well-defined.
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
CONTRIBUTING.md (1)
3-3: Consider rephrasing for style improvement.The phrase "are grateful for your help in making SafetyCLI better" could be reworded for better style. Consider using: "and appreciate your efforts to enhance SafetyCLI."
- and are grateful for your help in making SafetyCLI better. + and appreciate your efforts to enhance SafetyCLI.Tools
LanguageTool
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...other contributors. -good first issue: Highlights issues that are suitable for...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
CONTRIBUTING.md
71-71: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
Additional comments not posted (2)
CONTRIBUTING.md (2)
90-109: Well-structured Pull Request Process section.The guidelines for commit messages and merging changes are clear and adhere to the Conventional Commits specification.
110-111: Clear License section.The licensing information is concise and provides necessary legal clarity for contributors.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
CONTRIBUTING.md (2)
3-3: Consider improving the wording for clarity.The phrase "and are grateful for your help in making SafetyCLI better" can be rephrased for better engagement.
- First off, thanks for taking the time to contribute! We welcome contributions from everyone and are grateful for your help in making SafetyCLI better. + First off, thank you for taking the time to contribute! We welcome contributions from everyone and appreciate your efforts to improve SafetyCLI.Tools
LanguageTool
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
21-55: Clear guidelines for contributing.This section provides clear and useful guidelines for reporting bugs, suggesting enhancements, and improving documentation.
Additionally, consider addressing the loose punctuation marks in lines 36, 37, and 63 as suggested by static analysis tools.
- - `Critical`: Issues that break core functionality or pose significant security vulnerabilities. - - `High`, `Medium`, `Low`: Significance of bugs affecting users. - - `good first issue`: Highlights issues that are suitable for first-time contributors. + - `Critical`: Issues that break core functionality or pose significant security vulnerabilities. + - `High`, `Medium`, `Low`: Significance of bugs affecting users. + - `good first issue`: Highlights issues that are suitable for first-time contributors.Tools
LanguageTool
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CONTRIBUTING.md (1 hunks)
Additional context used
LanguageTool
CONTRIBUTING.md
[style] ~3-~3: The wording of this phrase can be improved.
Context: ...ryone and are grateful for your help in making SafetyCLI better. ## Table of Contents - [Contributing ...(MAKE_STYLE_BETTER)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ... that needs to be resolved. -Critical: Issues that break core functionality or...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ...icant security vulnerabilities. -High,Medium,Low: Significance of bugs a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...other contributors. -good first issue: Highlights issues that are suitable for...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (4)
CONTRIBUTING.md (4)
5-20: Table of Contents is well-organized.The table of contents is comprehensive and correctly linked to all sections.
65-89: Informative "Getting Started" section.This section provides clear instructions on the Code of Conduct, Development Setup, and Running Tests.
Ensure that the existing comment about removing extra spaces in the heading "Development Setup" is addressed.
90-109: Clear "Pull Request Process" section.The section clearly outlines the commit message format and the merging process, adhering to the Conventional Commits specification.
110-111: Concise "License" section.The section clearly states the licensing terms for contributions.
Description
This pull request adds a
CONTRIBUTING.mdfile to the repository, outlining the guidelines for contributing to the SafetyCLI project. The document provides details on how to report bugs, suggest enhancements, improve documentation, and submit code changes. It also includes information on the development setup, running tests, and the pull request process.Key Changes:
CONTRIBUTING.mdfile with sections on how to contribute, development setup, and pull request process.bug,enhancement,documentation, and more.Checklist:
Related Issues
N/A
Additional Notes
This document aims to provide a clear and structured way for contributors to participate in the project. Any feedback or further suggestions to improve the guidelines are welcome.
Summary by CodeRabbit
CONTRIBUTING.mdfile to guide users on how to contribute to the SafetyCLI project.