Docs: Various improvements #20
Conversation
Seluj78
added
documentation
WalkthroughThe recent updates to the Flask-Utils project include the addition of a detailed Code of Conduct, comprehensive contributing guidelines, and several GitHub-related badges in the README file. These changes aim to foster a positive community environment, guide contributors effectively, and enhance the project's visibility and professionalism on GitHub. Changes
Assessment against linked issues
Poem
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 Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (2)
README.md (2)
8-14: Consider removing or updating the TODO comment related to PyPI badges once the project is ready for release on PyPI.
Line range hint
68-68: Ensure fenced code blocks are surrounded by blank lines for proper Markdown formatting.+ + + +Also applies to: 73-73, 78-78, 85-85
Tools
LanguageTool
[style] ~1-~1: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 990 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context:
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- CODE_OF_CONDUCT.md (1 hunks)
- CONTRIBUTING.md (1 hunks)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~1-~1: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 990 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context:
[misspelling] ~84-~84: This word is normally spelled as one. (EN_COMPOUNDS_MULTI_THREADED)
Context: ...estsbash toxOR Run the tests multi-threadedbash tox -pCODE_OF_CONDUCT.md
[style] ~29-~29: Try using a synonym here to strengthen your wording. (COMMENT_REMARK)
Context: ...ces * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...CONTRIBUTING.md
[style] ~8-~8: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ...ur appreciation, which we would also be very happy about: > - Star the project > - Tweet a...
[uncategorized] ~66-~66: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...j78/flask-utilsissues?q=label%3Abug). - Also make sure to search the internet (inclu...
[style] ~66-~66: This phrase is redundant. Consider using “outside”. (OUTSIDE_OF)
Context: ...cluding Stack Overflow) to see if users outside of the GitHub community have discussed the...
[typographical] ~71-~71: Consider adding a comma after ‘Possibly’ for more clarity. (RB_LY_COMMA)
Context: ..., depending on what seems relevant. - Possibly your input and the output - Can you r...
[typographical] ~71-~71: It appears that a comma is missing. (COMMA_BEFORE_QUESTION_WITH_MD)
Context: .... - Possibly your input and the output - Can you reliably reproduce the issue? And c...
[uncategorized] ~77-~77: A comma may be missing after the conjunctive/linking adverb ‘Instead’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ... issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to...
[style] ~82-~82: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative. (TALK_ABOUT_DISCUSS)
Context: ...r it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) ...
[style] ~91-~91: As a shorter alternative for ‘able to’, consider using “can”. (BE_ABLE_TO)
Context: ...ntil they are reproduced. - If the team is able to reproduce the issue, it will be marked ...
[style] ~98-~98: Consider using a different adverb to strengthen your wording. (COMPLETELY_ENTIRELY)
Context: ...suggestion for Flask-Utils, **including completely new features and minor improvements to ...
[typographical] ~115-~115: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ...ected to see instead** and why. At this point you can also tell which alternatives do...
[style] ~122-~122: Often, this adverbial phrase is redundant. Consider using an alternative. (FIRST_OF_ALL)
Context: ... --> ### Your First Code Contribution First of all, you'll need to fork the project. Head ...
[uncategorized] ~177-~177: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ple, be one of the following: -Tests: for changes to the test suite -Docs:...
Markdownlint
README.md
68-68: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
73-73: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
78-78: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
85-85: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank linesCONTRIBUTING.md
28-28: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
36-36: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
53-53: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
166-166: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
167-167: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
188-188: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
129-129: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
131-131: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
9-9: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
123-123: null (MD034, no-bare-urls)
Bare URL used
171-171: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Additional comments not posted (1)
README.md (1)
2-6: Great addition of GitHub badges to enhance project visibility.
|
|
||
| * The use of sexualized language or imagery, and sexual attention or | ||
| advances | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks |
There was a problem hiding this comment.
Consider using stronger language to describe unacceptable behaviors to emphasize the seriousness.
- * Trolling, insulting or derogatory comments, and personal or political attacks
+ * Engaging in trolling, making insulting or derogatory comments, and initiating personal or political attacksCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * Trolling, insulting or derogatory comments, and personal or political attacks | |
| * Engaging in trolling, making insulting or derogatory comments, and initiating personal or political attacks |
Tools
LanguageTool
[style] ~29-~29: Try using a synonym here to strengthen your wording. (COMMENT_REMARK)
Context: ...ces * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...
|
|
||
| You can find the rules [here](https://github.com/Seluj78/flask-utils/blob/main/scripts/lint-commit.sh) but the gist of it is: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify the language for fenced code blocks to improve readability and syntax highlighting.
171~ ```bashTools
Markdownlint
171-171: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
|
|
||
| ```bash | ||
| git clone https://github.com/Seluj78/flask-utils.git | ||
| ``` |
There was a problem hiding this comment.
Add blank lines around fenced code blocks for proper Markdown formatting.
+
+ Also applies to: 131-131
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| ``` |
Tools
Markdownlint
129-129: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
| - [Commit Messages](#commit-messages) | ||
| - [Join The Project Team](#join-the-project-team) | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove extra blank lines to maintain consistency and cleanliness in the document.
-
-
- Also applies to: 36-36, 95-95
Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
28-28: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
|
|
||
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice <!-- omit in toc --> |
There was a problem hiding this comment.
Ensure headings are surrounded by blank lines to adhere to Markdown best practices.
+
+
+
+
+ Also applies to: 166-166, 167-167, 188-188
Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
53-53: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Fixes #14
Fixes #13
Fixes #7
Summary by CodeRabbit
Documentation
New Features