-
Notifications
You must be signed in to change notification settings - Fork 4
Update buying_things_for_the_lab.md #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Reviewer's Guide by SourceryThis pull request adds a new markdown file 'buying_things_for_the_lab.md' with placeholder content. The file includes a main heading, a subheading, and two paragraphs of Lorem Ipsum text. File-Level Changes
Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @marcobarilari - I've reviewed your changes - here's some feedback:
Overall Comments:
- The content of the file doesn't match its filename. If this is intended to be a placeholder, please clearly indicate so and consider using a skeleton structure relevant to 'buying things for the lab' instead of lorem ipsum text.
- The markdown formatting could be improved. Consider removing unnecessary blank lines and ensuring consistent use of header levels.
- If this file is meant to provide guidelines for purchasing lab equipment, consider creating a basic structure with empty sections instead of using placeholder text. This would be more useful for future development.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
doc/buying_things_for_the_lab.md
Outdated
# Lorem ipsum dolor | ||
|
||
## sit amet, consectetur adipiscing elit. Sed vestibulum semper felis quis accumsan. | ||
|
||
|
||
Ut consequat augue quis dui sagittis, eget molestie odio vehicula. Vestibulum volutpat tristique ante vitae convallis. | ||
|
||
Integer condimentum nunc condimentum egestas tristique. Nulla facilisi. Duis pulvinar volutpat diam, a aliquam nibh feugiat lobortis. Mauris pretium mollis elit vel venenatis. Fusce tincidunt lorem id lectus tempor vulputate. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (documentation): The content appears to be placeholder text (Lorem ipsum) rather than actual documentation.
Please replace this with the intended content about buying things for the lab. If this is intentionally left as a placeholder, consider adding a TODO comment to indicate that it needs to be filled in later.
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check languages
Co-authored-by: Filippo Cerpelloni <filippo.cerpelloni@gmail.com>
This is a mock pr with just some text filler
Summary by Sourcery
Add initial content to the 'buying_things_for_the_lab.md' documentation file with placeholder text.
Documentation: