Update ReadMe.md before 2025-04#2
Conversation
Reviewer's Guide by SourceryThis pull request updates the ReadMe.md file to clarify the meaning of the phrase 'Before 2025-04', specifying that it means complete no later than 2025-03-31. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @HwWobbe - I've reviewed your changes - here's some feedback:
Overall Comments:
- This change doesn't seem substantial enough to warrant a pull request.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ### Notes: | ||
| - review the use of Projects | ||
| - try using Asks ... |
There was a problem hiding this comment.
suggestion (typo): "Asks" should likely be lowercase ("asks").
There was a problem hiding this comment.
perhaps Asks... would be an adequate indication that this string is capitalized since it is expected to be recognized as CamelCase in other environments that it exists in.
There was a problem hiding this comment.
Thanks for the feedback! I understand the desire to indicate that "Asks" is intended to be CamelCase. However, in the context of a README, prioritizing readability and natural language flow is generally preferred. Using "asks" in lowercase would likely be more easily understood by a wider audience.
If the term "Asks" is consistently used as CamelCase within the project's codebase or related documentation, it might be worth adding a separate note or glossary entry to explicitly define it. This would provide clarity without sacrificing readability in the main text.
Alternatively, consider rephrasing the sentence to avoid the issue altogether. For example, "try using question prompts..." or "consider incorporating a question-based approach..."
|
Generate a GitHub issue from the Asks review comment |
Summary by Sourcery
Documentation: