-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Insufficient guidance in CONTRIBUTING document for feature branches #4477
Comments
|
Linking this to the larger discussion within #1868 |
@kotwanikunal Quick idea - When on a 'special' branch such as when the name starts with |
Is your feature request related to a problem? Please describe.
Pull request checks now fail without an entry in the CHANGELOG. In the "happy path" for commits to
main
or backports to a version branch, this is a good thing. However, following the same policy for commits to a feature branch may be problematic.Including the commits in the changelog in the feature branch will pass the check, but will create many merge conflicts in the future when the lines around them are moved to a release.
Describe the solution you'd like
Add documentation to CONTRIBUTING specifying that PRs for a feature branch should be in a separate section. I'm happy to do this, but wanted community concurrence with this plan.
Describe alternatives you've considered
Adding changes inline will create a lot of extra work resolving merge conflicts after a release.
Not documenting feature branch changes will lead to documentation technical debt when the feature is eventually merged to main and the changes must be brought over.
The text was updated successfully, but these errors were encountered: