-
Notifications
You must be signed in to change notification settings - Fork 167
Create CONTRIBUTING.md #34
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 GuideIntroduced a comprehensive CONTRIBUTING.md that outlines project prerequisites, development environment setup, contribution and code standards, project structure, Docker workflows, licensing, and community support to streamline onboarding and maintain quality. 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 @Danielpeter-99 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: 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.
|
|
||
| ## 📂 Project Structure and Best Practices | ||
|
|
||
| * Follow the directory structure and naming conventions described in `.cursorrules`. |
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.
suggestion: Suggest clarifying or linking to .cursorrules for new contributors.
Consider briefly explaining what .cursorrules is or linking directly to the file to help new contributors understand its purpose.
| * Follow the directory structure and naming conventions described in `.cursorrules`. | |
| * Follow the directory structure and naming conventions described in [`.cursorrules`](./.cursorrules). | |
| * The `.cursorrules` file defines project-specific rules for directory structure, file naming, and other conventions. New contributors should review this file to understand and follow these guidelines. |
Summary by Sourcery
Add a comprehensive CONTRIBUTING.md outlining prerequisites, development setup, coding standards, issue and PR guidelines, Docker workflows, licensing, and community support channels.
Documentation: