-
Notifications
You must be signed in to change notification settings - Fork 100
[MINOR] contributing guide #233
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
Signed-off-by: Vedansh Saini <[email protected]>
Reviewer's GuideThis PR extracts and expands the project's contribution instructions into a dedicated CONTRIBUTING.md file, refactors the README.md to link to it and cleans up obsolete sections including language localization and PR guidelines, and adds a license section. File-Level Changes
Assessment against linked issues
Possibly linked issues
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 there - I've reviewed your changes - here's some feedback:
- Consider adding the new Contributing section to the README’s table of contents so it’s easy for users to discover.
- In CONTRIBUTING.md, clarify whether contributors should load the
srcfolder or the built extension folder when testing locally, to avoid confusion. - The GitHub personal access token setup may be optional for many contributors—consider marking it as an advanced step to keep the initial setup lean.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding the new Contributing section to the README’s table of contents so it’s easy for users to discover.
- In CONTRIBUTING.md, clarify whether contributors should load the `src` folder or the built extension folder when testing locally, to avoid confusion.
- The GitHub personal access token setup may be optional for many contributors—consider marking it as an advanced step to keep the initial setup lean.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
The failing check is not related to this specific PR, its a thing of release drafter workflow. This has to be handled separately, currently the drafter workflow produces release notes. |
📌 Fixes
Fixes #232
📝 Summary of Changes
✅ Checklist
👀 Reviewer Notes
Add any special notes for the reviewer here
Summary by Sourcery
Add a dedicated contributing guide and update the README to reference it
Documentation: