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 basic Issue and PR Templates #410

Merged
merged 32 commits into from
Sep 22, 2022

Conversation

CGBassPlayer
Copy link
Collaborator

@CGBassPlayer CGBassPlayer commented Sep 8, 2022

Fixes #390

Adds issue templates to help users create issues. Currently the templates are

  • Issue (Forms)
    • Bug found on the website
    • Feature Request
    • Issue with development environment
    • Issue with episode information (dead links, typos, etc)
  • Pull Request (Markdown)
    • Basic Bug Fix

@CGBassPlayer CGBassPlayer marked this pull request as ready for review September 11, 2022 19:06
@gerbrent
Copy link
Collaborator

THIS IS SO GREAT - thanks @CGBassPlayer .
Will have a look in a day or two.. (am travelling to the studio!!)

Copy link
Collaborator

@elreydetoda elreydetoda left a comment

Choose a reason for hiding this comment

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

A few small details/questions that I think might enhance it a bit more, but IMO optional. Very nicely done @CGBassPlayer !

It might be nice to have screenshots of each template as well, just so we can capture what they looked like for this PR.


Also, I don't known how familiar you are with git, but what I've done when I needed to merge something with my main branch to demonstrate functionality for something. Is after I merge it I reset it to JB repo's HEAD.

So, I've already added JB's repo as a remote with: git remote add upstream https://github.com/JupiterBroadcasting/infra.git

Then if I've merged my branch already and I want to reset my main branch I run: git reset --hard upstream/main and then I have to force push (since I'm re-writing history for my git repo): git push -f.

I will say though, be careful with force pushes (it can be a dangerous thing and unrecoverable (like how I messed up here and had to re-implement my previous work)), so just make sure to use it sparingly.


So besides the suggestions I've made and potential screenshots as enhancements everything from a functionality perspective LGTM. This is going to be an awesome addition to the repo! Thanks again @CGBassPlayer for doing all this research/work!

(Going to leave this open for @gerbrent since he showed interest in it before)

.github/ISSUE_TEMPLATE/bug_shownotes.yml Outdated Show resolved Hide resolved
Comment on lines +37 to +38
For dead links, if you find a working link, please add it in! This can help us get the link updated faster.
For typos, feel free to include the correction and a screenshot.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I like that you give examples for this 😁

Comment on lines +46 to +47
# - label: I have read and accept the [Code of Conduct](https://docs.github.com/articles/github-community-guidelines)
# required: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ya, we should probably make one of these, I think this is a pretty standard one that I've seen others use before: https://www.contributor-covenant.org/

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have them commented out until we have something. That way it is ready to go when we are ready

.github/ISSUE_TEMPLATE/bug_website.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Show resolved Hide resolved
@CGBassPlayer
Copy link
Collaborator Author

CGBassPlayer commented Sep 16, 2022

Here are the screenshots so you can see what the forms look like. The table at the top is the meta data
Name and About are what displays when you are choosing an issue type. And the labels are assignees are pretty straight forward.

Episode Issue

image

Website Issue

image

Development Issue

image

Feature Request

image

I will look over (and probably implement) all your suggestions.

Copy link
Collaborator

@elreydetoda elreydetoda left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for implementing those changes @CGBassPlayer. LGTM 😁

(still going to let @gerbrent review it, but you've got my approval 🥳 )

@gerbrent
Copy link
Collaborator

Love all of this!!! Super well thought out and implemented. .....launching!

@gerbrent gerbrent merged commit cb478ad into JupiterBroadcasting:main Sep 22, 2022
@gerbrent
Copy link
Collaborator

woooooo!!!

image

@CGBassPlayer CGBassPlayer deleted the feature/issue-template branch September 22, 2022 20:20
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.

Issue and/or PR Templates
3 participants