-
Notifications
You must be signed in to change notification settings - Fork 62
Add contributor details to introduction #200
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
base: master
Are you sure you want to change the base?
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a new Contributor section to the introduction documentation, listing the PR author’s name and GitHub profile link. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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 - I've left some high level feedback:
- Consider aligning with the existing project pattern for acknowledging contributors (e.g., a shared CONTRIBUTORS/AUTHORS section or file) rather than adding a single personal entry directly into
introduction.md, to keep the introduction focused on the project itself. - You can simplify the formatting by avoiding extra blank lines before and after the new
## Contributorheading so the document’s spacing remains consistent with the rest of the file.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider aligning with the existing project pattern for acknowledging contributors (e.g., a shared CONTRIBUTORS/AUTHORS section or file) rather than adding a single personal entry directly into `introduction.md`, to keep the introduction focused on the project itself.
- You can simplify the formatting by avoiding extra blank lines before and after the new `## Contributor` heading so the document’s spacing remains consistent with the rest of the file.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Hello, |
|
Thanks for the review and the suggestion. I’ve reverted the contributor section from introduction.md to keep the introduction focused on the project and aligned with the existing documentation structure. Please let me know if contributors should instead be acknowledged in a separate file or section. |
What changes have you introduced?
Does this PR introduce a breaking change?
Preview / Steps to verify your work:
You can check the
introduction.mdfile in the repository; under the Contributors section, it now shows my details:GitHub: https://github.com/Suhani370
Summary by Sourcery
Documentation: