-
Notifications
You must be signed in to change notification settings - Fork 426
[Internal] Update Contributing guide #4404
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
base: main
Are you sure you want to change the base?
Conversation
CONTRIBUTING.md
Outdated
@@ -51,6 +51,8 @@ Code contributions—bug fixes, new development, test improvement — all follow | |||
git commit -m "commit message here" | |||
``` | |||
|
|||
1. Document your changes in the `NEXT_CHANGELOG.md` under the appropriate heading. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This may lead to conflicts when we have many PRs in parallel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is true. It's a tradeoff of this approach, but I think it should be acceptable as long as the test loop can be made faster. We are going to build a plan for this, involving setting up a test cache where we run integration tests to make sure that commits that don't affect code (like docs changes or changelog updates) don't need to reexecute tests.
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Changes
Update contributing guide to refer to
NEXT_CHANGELOG.md
.Tests
make test
run locallydocs/
folderinternal/acceptance