Add new PR template for sync.yml edits #742
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
No broken url errors! 🎉 |
|
No spelling errors! 🎉 |
|
I'm not sure why the code of conduct commit is showing up in this list. But I also just saw in changed files that it's highlighting the code of conduct addition to the starting-course.yml file. |
|
Re-rendered previews from the latest commit:
* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea. Updated at 2024-04-05 with changes from the latest commit 68f1479 |
cansavvy
approved these changes
Apr 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose/implementation Section
What changes are being implemented in this Pull Request and what was your approach?
The changes being implemented in this pull request are
PULL_REQUEST_TEMPLATEwithin the.githubdirectory (because I was following this guide from GitHub)pull_request_template_general.mdand adding a header)add_to_sync_template.md) within the subdirectory with a header that automatically assigns Candace and explains that sync.yml is being edited to enroll a new repository in OTTR updates.github/workflows/starting-course.ymlfile because we don't want downstream repos to create issues that assign Candace for reviewWhat GitHub issue does your pull request address?
I think this PR addresses Issue #636. I understood the issue to mean providing a specific PR template. Perhaps it would be useful to have a commit message template, but I think that the documentation does a really good job of explaining how to write a helpful commit message and commit changes to a new branch.
Tell potential reviewers what kind of feedback you are soliciting.
Does this look like a helpful addition that won't break things? If so, I can make a similar PR template (and corresponding changes) in the OTTR_Template_Websites and OTTR_Quizzes Repos.
I was specifically interested in potentially tackling this issue while working on the OTTR Cheatsheets and realizing that using a specific PR template would be something that I could include in that.