Skip to content

chore(docs): update CONTRIBUTING.md with additional information #310

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

Merged
merged 2 commits into from
Jun 5, 2025

Conversation

avivkeller
Copy link
Member

Let's give new users as much information as we can in order to set them up for success.

@Copilot Copilot AI review requested due to automatic review settings June 5, 2025 13:44
@avivkeller avivkeller requested a review from a team as a code owner June 5, 2025 13:44
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the CONTRIBUTING.md file to provide additional guidance and detail for new contributors. Key changes include the addition of a detailed table of contents, expanded sections on setup, development workflow, testing, code quality, and commit guidelines.

Comments suppressed due to low confidence (1)

CONTRIBUTING.md:96

  • There seems to be an extra space in the command flag; consider correcting it to 'node --run test:coverage' to prevent confusion when copying the command.
node -- run test:coverage # To check code coverage

Copy link

codecov bot commented Jun 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.90%. Comparing base (440da36) to head (a3f4747).
Report is 7 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #310   +/-   ##
=======================================
  Coverage   48.90%   48.90%           
=======================================
  Files          82       82           
  Lines        6825     6825           
  Branches      277      277           
=======================================
  Hits         3338     3338           
  Misses       3484     3484           
  Partials        3        3           

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT !

@avivkeller avivkeller merged commit 6d86c0c into main Jun 5, 2025
10 checks passed
@avivkeller avivkeller deleted the chore/contribution branch June 5, 2025 18:07
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.

3 participants