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

Update Git standards to remove optional description merging PRs #62

Open
ghost opened this issue Apr 4, 2024 · 0 comments
Open

Update Git standards to remove optional description merging PRs #62

ghost opened this issue Apr 4, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ghost
Copy link

ghost commented Apr 4, 2024

Description:

As per our current Git coding standards, when merging Pull Requests, we are required to do a "Squash and merge", but no further details are added in this process.

In practice, we also ensure the following during "Squash and merge" (in GitHub atleast):

1. Description should match PR title since that is shown in commit history
2. PR number should be there (ex: #59) in the description
3. Remove everything from optional extended description

It would be good if we can add it to the documents, if this is a step that is normalised across both GitLab and GitHub.

@ghost ghost added the documentation Improvements or additions to documentation label Apr 4, 2024
@osm-vishnukyatannawar osm-vishnukyatannawar self-assigned this Apr 9, 2024
@osm-vishnukyatannawar osm-vishnukyatannawar added the enhancement New feature or request label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant