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

Repository management good practices #14

Open
Firefly35 opened this issue Jun 30, 2023 · 0 comments
Open

Repository management good practices #14

Firefly35 opened this issue Jun 30, 2023 · 0 comments

Comments

@Firefly35
Copy link
Contributor

Firefly35 commented Jun 30, 2023

  • avoid unexplicit merge commits on master (Merge develop is not an explicit commit). Merge commits on master must contain the synthesis of the changelog occured between commits on master
  • update CHANGELOG.md to reflect this information (not only update the xpcf version). MAINTAIN THE CHANGELOG.
  • latest commit[a3a1ee6] removes exception handling/rewrapping: exception handling and error handling were made ON PURPOSE. Exceptions are wrapped in more specialized exceptions at will, removing the wrapping prevent to categorize exceptions from the user point of view (see Factory removal of such wrapping). Moreover no documentation about newly raised exceptions is added in the XPCF concerned headers. Update documentation in headers accordingly.
  • Commits messages must reflect the scope of their changes: for instance ef13dc9 "fix(update): grpc generators update" not only modifies the grpc generator, but also changes the exception handling in xpcf factory which is sensitive. There is no relation between the commit message and the exception handling/rewrapping in xpcf Factory.

Maybe there must be a reviewing process before anything is merged in master with adequate people to validate changes.

@Firefly35 Firefly35 reopened this Jul 3, 2023
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

No branches or pull requests

1 participant