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 pull_request_template.md #1713

Open
wants to merge 2 commits into
base: hotfix-merge-2024-09-26
Choose a base branch
from

Conversation

GregoryPost
Copy link
Member

@GregoryPost GregoryPost commented Sep 12, 2024

Description

Document workflow for hotfix branch

Pull Request Checklist:

Pre-Approval

  • There is a description section in the pull request that details what the proposed changes do. It can be very brief if need be, but it ought to exist.
  • Hotfixes should be branched off of the master branch and squash and merged into the hotfix branch.
  • Features and backlog bugs should be merged into the Development branch, NOT master
  • All new text is preferably internationalized (i.e., no end-user-visible text is hard-coded on the PHP pages), and the spreadsheet tracking internationalizations has been updated either with a new row or with checkmarks to existing rows.
  • There are no linter errors
  • New features have responsive design (i.e., look aesthetically pleasing both full screen and with small or mobile screens)
  • Symbiota coding standards have been followed
  • If any files have been reformatted (e.g., by an autoformatter), the reformat is its own, separate commit in the PR
  • Comment which GitHub issue(s), if any does this PR address
  • If this PR makes any changes that would require additional configuration of any Symbiota portals outside of the files tracked in this repository, make sure that those changes are detailed in this document.

Post-Approval

  • It is the code author's responsibility to merge their own pull request after it has been approved
  • If this PR represents a merge into the Development branch, remember to use the squash & merge option
  • If this PR represents a merge from the Development branch into the master branch, remember to use the merge option
  • If this PR represents a hotfix into the master branch, a subsequent PR from master into Development should be made merge option (i.e., no squash).
  • If the dev team has agreed that this PR represents the last PR going into the Development branch before a tagged release (i.e., before an imminent merge into the master branch), make sure to notify the team and lock the Development branch to prevent accidental merges while QA takes place. Follow the release protocol here.
  • Don't forget to delete your feature branch upon merge. Ignore this step as required.

Thanks for contributing and keeping it clean!

Document workflow for hotfix branch
@GregoryPost GregoryPost marked this pull request as ready for review September 12, 2024 01:12
Copy link
Member

@egbot egbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should discuss this at our next dev meeting. Individual hotfixes rarely involve more than a commit or two, and thus probably don't need to be squashed when merged into 'hotfix', especially because the final hotfix will be squash merged into 'master'. But maybe better to discuss as a group.

@GregoryPost
Copy link
Member Author

I am good with changing the language to a normal merge. I think I was confused about what we had discussed. Now that you mention it I agree that a normal merge is better as it allows for for individual commit cherry picking / rollbacks prior to merging the hotfix branch into master - when it will be squashed.

Adjusted hotfix merge instructions.
Copy link
Collaborator

@Atticus29 Atticus29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested one logic and one typo fix.

@@ -17,8 +17,11 @@

- [ ] It is the code author's responsibility to merge their own pull request after it has been approved
- [ ] If this PR represents a merge into the `Development` branch, remember to use the **squash & merge** option
- [ ] If this PR represents a merge into the `hotfix` branch, remember to use the **squash & merge** option
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just, squash here as well, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just merge into the hotfix branch, since the hotfix branch will be eventually Squash & Merged into Master. We don't need to Squash Merge twice.

- [ ] If this PR represents a hotfix into the `master` branch, a subsequent PR from `master` into `Development` should be made **merge** option (i.e., no squash).
- [ ] If this PR represents a merge from the `hotfix` branch into the `master` branch use the **squash & merge** option
- [ ] a subsequent PR from `master` into `Development` should be made with the **merge** option (i.e., no squash).
- [ ] **Immediatly** after merging into `master` and `Development` increment the Symbiota version number in the symbase.php file and commit to the `hotfix` branch.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo with immediately here.

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

Successfully merging this pull request may close these issues.

3 participants