Skip to content

Repository management good practices #14

@Firefly35

Description

@Firefly35
  • 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions