Skip to content

Conversation

@Danielpeter-99
Copy link
Contributor

@Danielpeter-99 Danielpeter-99 commented May 30, 2025

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:

  • Introduce CONTRIBUTING.md with step-by-step environment setup for backend and frontend, code style rules, and Docker commands.
  • Document issue and pull request conventions including testing and commit message standards.
  • Provide contributor license information and links to community support resources.

@sourcery-ai
Copy link

sourcery-ai bot commented May 30, 2025

Reviewer's Guide

Introduced 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

Change Details Files
Documented project prerequisites and local environment setup
  • Defined backend and frontend system requirements
  • Outlined virtual environment creation and dependency installation
  • Provided commands for database migration, seeding, and application startup
CONTRIBUTING.md
Specified issue and pull request guidelines
  • Advised checking existing issues before opening new ones
  • Required clear descriptions, issue references, and focused scope for PRs
  • Enforced inclusion of tests and passing lint/format checks
CONTRIBUTING.md
Established code standards and project structure conventions
  • Mandated English for all comments, names, and commit messages
  • Enforced indentation, line length, and naming patterns
  • Outlined directory layout, validation rules, and documentation requirements
CONTRIBUTING.md
Added Docker-based development workflow
  • Provided commands to build, start, and stop the Docker stack
  • Included instructions for seeding the database within containers
CONTRIBUTING.md
Included contributor licensing and community support links
  • Referenced Apache License 2.0 for contributions
  • Linked to WhatsApp, Discord, and official documentation channels
CONTRIBUTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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`.
Copy link

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.

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.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop May 31, 2025 14:28
@DavidsonGomes DavidsonGomes merged commit 3ba85d9 into EvolutionAPI:develop May 31, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants