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

Add instructions for linting and formatting back to CONTRIBUTING.md #4169

Closed
jaydeluca opened this issue Mar 17, 2024 · 1 comment
Closed
Labels
bug Something isn't working

Comments

@jaydeluca
Copy link
Member

What needs to be changed?
As a contributor, I would like documentation for how to ensure my code is formatted properly before submitting PRs.

There used to be a section titled "Submitting a change" that documented the npm run test-and-fix command, which can catch issues recommends running npm run fix:format to fix them.

This information was removed in this PR, so I want to raise this issue before going ahead and adding it back, in case it was intentional and preferred not to be there.

I would like to add these back if there is no objection.

What is the name + path of the page that needs changed?
/CONTRIBUTING.md

@jaydeluca jaydeluca added the bug Something isn't working label Mar 17, 2024
@jaydeluca jaydeluca changed the title Re-add instructions for linting and formatting back to CONTRIBUTING.md Add instructions for linting and formatting back to CONTRIBUTING.md Mar 17, 2024
@theletterf
Copy link
Member

Hi Jay! Thanks for filing this issue.

The missing info is here now: https://opentelemetry.io/docs/contributing/pr-checks/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants