Create CONTRIBUTING.md#34
Merged
DavidsonGomes merged 1 commit intoEvolutionAPI:developfrom May 31, 2025
Merged
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.
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.
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.
Suggested change
| * 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: