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: add editorconfig to enforce private and public member naming convention #137

Merged
merged 3 commits into from
Aug 20, 2024

Conversation

daniel-pebble
Copy link
Contributor

@daniel-pebble daniel-pebble commented Aug 10, 2024

What this PR does / why we need it

This PR adds a editorconfig file which will enforce good naming convention when using support IDEs. Thankfully most private/public members already conform to this standard.
Private = _camalCase
Public = PascalCase

Which issue(s) this PR resolves / fixes

N/A

Please check the following list

  • Does the affected code have corresponding tests, e.g. unit test, E2E test? No
  • Does this change require a documentation update? No
  • Does this introduce breaking changes that would require an announcement or bumping the major version? No
  • Do all new files have an appropriate license header? No

Signed-off-by: Daniel Robinson <[email protected]>
Copy link

codecov bot commented Aug 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.48%. Comparing base (1f939a5) to head (65ac11b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #137   +/-   ##
=======================================
  Coverage   80.48%   80.48%           
=======================================
  Files          30       30           
  Lines         902      902           
  Branches      109      109           
=======================================
  Hits          726      726           
  Misses        122      122           
  Partials       54       54           

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

.editorconfig Outdated Show resolved Hide resolved
.editorconfig Outdated Show resolved Hide resolved
@shizhMSFT shizhMSFT changed the title Added editorconfig to enforce private and public member naming convention chore: add editorconfig to enforce private and public member naming convention Aug 10, 2024
Signed-off-by: Daniel Robinson <[email protected]>
Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@shizhMSFT shizhMSFT merged commit 3a5d2fb into oras-project:main Aug 20, 2024
7 checks passed
@Wwwsylvia Wwwsylvia mentioned this pull request Sep 25, 2024
3 tasks
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