Skip to content
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

[chore][CONTRIBUTING.md] Move coding guidelines to separate document #11484

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mx-psi
Copy link
Member

@mx-psi mx-psi commented Oct 18, 2024

Description

Moves coding guidelines to a separate document where we can work on expanding them. This is the largest part of the contributing document and it was making it a bit difficult to work with and scary-looking for newcomers.

@mx-psi mx-psi requested a review from a team as a code owner October 18, 2024 10:10
@mx-psi mx-psi requested a review from atoulme October 18, 2024 10:10
@mx-psi mx-psi force-pushed the mx-psi/split-off-coding-guidelines branch from d5aa619 to d2a433c Compare October 18, 2024 10:13
@mx-psi
Copy link
Member Author

mx-psi commented Oct 18, 2024

@atoulme I want to work on improving the coding guidelines (specifically, making naming conventions clearer as we have discussed offline a couple times). This is the very first step, moving them to a separate doc since CONTRIBUTING.md was getting a bit too big. Can you take a look?

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.48%. Comparing base (68e1000) to head (d2a433c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11484   +/-   ##
=======================================
  Coverage   91.48%   91.48%           
=======================================
  Files         433      433           
  Lines       23617    23617           
=======================================
  Hits        21607    21607           
  Misses       1642     1642           
  Partials      368      368           

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

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.

4 participants