-
Notifications
You must be signed in to change notification settings - Fork 601
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
chore: update issue and PR templates #3896
chore: update issue and PR templates #3896
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Just one thought above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need the emoji's in the headings? Do they add value? To my eyes, they are a bit distracting and moves my focus away from the text.
…ue-templates' into users/eisenbergeffect/pr-and-issue-templates
This is ready to go but I'm marking this as |
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Removed stale warning as this is temporarily blocked, not stale. |
@@ -0,0 +1,20 @@ | |||
--- | |||
name: 📚 Documentation | |||
about: Find an inaccuracy in the documentation or something missing? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'Find inaccuracies in the documentation or something missing?'
@EisenbergEffect per your question regarding |
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
@EisenbergEffect I think we are ready to bring this in :) |
@chrisdholt Should I merge now or wait to do it as part of our meeting tomorrow? |
Code Climate has analyzed commit 298679b and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 85.2% (0.0% change). View more on Code Climate. |
I think you're probably good now to be honest. We can do it tomorrow as well, but I don't see a huge problem with merging prior to tomorrow. |
Pull Request
📖 Description
Updating our issue and PR templates is the last piece of the work to refresh our GitHub usage approach. We'd like to have a friendly set of templates and guidance for the most common scenarios. This is my take on that based on some prior projects of mine as well as notes I've made over the last few months from team feedback.
Note: While it's technically possible to have multipe PR tempaltes, you can't select them through the UI. The submitter needs to know the template name and add it to the query string, which isn't very user friendly. For this reason, this PR sticks with a single PR template and instead re-organizes the checklists.
🎫 Issues
👩💻 Reviewer Notes
This PR (manually) uses the new template, so take a moment to think through how you are experiencing the template right now. A primary characteristic of a good PR is to present an excellent reading experience since the PR will be read by many people, not only now but possibly months or years later. After considering this, have a look at the changed files in this PR. They are all markdown as this is a content-only change. No code is affected. The new templates make use of emojis and commented guidance for each section. What do you think of this approach?
📑 Test Plan
No testing was done as part of this PR other than viewing how files look on GitHub.
✅ Checklist
General
$ yarn change
- NOTE: Note implemented yet. Should we leave this off?⏭ Next Steps
This completes the known initial set of work to update our GitHub use for FAST. We'll continue to take feedback and make modification to our templates, labels, issues, PRs, projects, milestones, etc.