make contribution easier

[Halleck45]

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced the contribution guidelines to improve clarity and engagement for new contributors.
  • Introduced a ReportersFactory for streamlined report generation based on configuration settings.
  • Added new methods to the Engine interface for improved functionality and configuration management.

• Bug Fixes

  • Adjusted report generator imports and methods for better organization and usability.

• Documentation

  • Updated documentation for the Reporter interface to clarify method purposes.

• Chores

  • Reorganized template directories for report generation to enhance maintainability.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 35.13514% with 24 lines in your changes missing coverage. Please review.

Project coverage is 51.42%. Comparing base (528e8e4) to head (b2d5ca0).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/Report/ReportersFactory.go	0.00%	16 Missing ⚠️
src/Report/HtmlReportGenerator.go	0.00%	5 Missing ⚠️
src/Report/JsonReportGenerator.go	66.66%	1 Missing ⚠️
src/Report/MarkdownReportGenerator.go	80.00%	1 Missing ⚠️
src/Report/OpenMetricsGenerator.go	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
- Coverage   54.39%   51.42%   -2.97%     
==========================================
  Files          44       46       +2     
  Lines        5006     5293     +287     
==========================================
- Hits         2723     2722       -1     
- Misses       2050     2340     +290     
+ Partials      233      231       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve significant updates to the project's contributing guidelines and the introduction of a factory pattern for report generation. The .github/CONTRIBUTING.md file has been restructured for clarity, incorporating new sections and instructions for contributors. Additionally, several interfaces in the codebase, particularly in the src/Engine and src/Report directories, have been updated with new method signatures. A new ReportersFactory has been introduced to streamline report generation based on configuration, consolidating previous report generation logic.

Changes

File	Change Summary
.github/CONTRIBUTING.md	Restructured content for clarity; replaced "Requirements" with a welcoming introduction; added setup instructions and new sections for tests, source code organization, and contributing guidelines.
src/Report/Reporter.go	Added documentation for Generate method.
src/Engine/Engine.go	Added several method signatures to the Engine interface: Ensure(), DumpAST(), Finish(), SetProgressbar(), SetConfiguration(), and Parse().
src/Report/HtmlReportGenerator.go	Updated variable name from content to htmlContent; modified method signatures to return Reporter and []GeneratedReport.
src/Report/JsonReportGenerator.go	Updated method signatures to return Reporter and []GeneratedReport.
src/Report/MarkdownReportGenerator.go	Updated variable name from content to mdContent; modified method signatures to return Reporter and []GeneratedReport.
src/Report/OpenMetricsGenerator.go	Updated method signatures to return Reporter and []GeneratedReport.
src/Report/ReportersFactory.go	Introduced ReportersFactory struct with a method Factory for creating reporter instances based on configuration.
src/Command/AnalyzeCommand.go	Removed specific report generation imports; refactored Execute method to use reportersFactory.Factory(v.configuration) for report generation.
src/Cli/ScreenHtmlReport.go	Modified import statement to generalize report generation access; updated View method to utilize the new import.

Possibly related PRs

• HTML report for banch comparaison #61: The changes in the .github/CONTRIBUTING.md file emphasize the role of the Reporter interface, which is directly related to the modifications made in the src/Report/Reporter.go file, where the Reporter interface is defined.
• Improving DX, adding a --ci option and listing generated reports in output #68: The introduction of the --ci option in the CLI and the listing of generated reports in the output enhances the user experience, which aligns with the changes made in the src/Command/AnalyzeCommand.go file, where report generation logic is improved and user feedback is enhanced.

Warning

Rate limit exceeded

@Halleck45 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 26 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 65052ba and b2d5ca0.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.