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

Add git instructions to bug report and feature issue forms #9273

Conversation

rebecca-shoptaw
Copy link
Collaborator

@rebecca-shoptaw rebecca-shoptaw commented May 15, 2024

Closes #9269.

Feature. Adds instructions re: basic git pull/push operations to the issue template -- should help contributors avoid merge conflicts/bizarre issues/confusion as a result of out-of-date branches.

Technical

  • I left out the "suggested branch name" section that was originally suggested for now, to avoid giving submitters more to do, and to make the new section as simple and legible as possible -- but happy to add it back in if people have been having issues with badly-named branches!
  • Added --ff-only to the pull instructions (thanks @tfmorris!) in the Git Cheat Sheet
  • I couldn't immediately find a way to make a non-editable section of the template (and as we discussed, there are some cases where the instructions wouldn't be necessary), so I left it editable but with a note re: leaving it as is, which hopefully only experienced contributors will ignore.
  • Happy to take any more input re: wording, placement, etc.!

Testing

  1. Make a new GitHub issue for a feature or bug
  2. You should see a new reminder re: keeping branches up to date at the bottom of the issue, both in the form and in the submitted version

Screenshot

Current Implementation:
New note-only implementation

Previous implementation:
Working with Git screenshot

Screenshot via a markdown previewer.

Stakeholders

@RayBB @merwhite11 @mekarpeles

@github-actions github-actions bot added the Priority: 2 Important, as time permits. [managed] label May 15, 2024
@rebecca-shoptaw rebecca-shoptaw force-pushed the 9269/feature/add-git-instructions-to-issue-template branch from 248ea94 to 94ef99f Compare May 21, 2024 20:51
Copy link
Collaborator

@RayBB RayBB left a comment

Choose a reason for hiding this comment

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

Looks good to me! Please add a newline to the end of the file though :)

I don't have merge powers so marking as needs staff.

@RayBB RayBB added the Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this. label May 21, 2024
@rebecca-shoptaw rebecca-shoptaw force-pushed the 9269/feature/add-git-instructions-to-issue-template branch from 94ef99f to 5f2dbae Compare May 21, 2024 21:13
@rebecca-shoptaw
Copy link
Collaborator Author

rebecca-shoptaw commented May 21, 2024

Looks good to me! Please add a newline to the end of the file though :)

@RayBB Done! Good catch 🙂

@cdrini cdrini merged commit 47d6bd6 into internetarchive:master May 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Staff / Internal Reviewed a PR but don't have merge powers? Use this. Priority: 2 Important, as time permits. [managed]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add simple git instructions to GitHub issue templates
3 participants