-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from jhudsl/issueTemplate
Adding Issue and Pull Request templates
- Loading branch information
Showing
9 changed files
with
247 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Add your new website to syncs/OTTR updates | ||
about: Provide information about your new website (which uses the OTTR Website template) so that we can enroll it in OTTR updates | ||
title: '' | ||
labels: '' | ||
assignees: cansavvy | ||
|
||
--- | ||
|
||
## What is the name of your new repository? | ||
<!-- The name of the repo. Ex the name of this repo is OTTR_Template_Website --> | ||
|
||
## What username or organization is your new repository associated with? | ||
<!-- The name of the username or organization where the new repository is located . Ex this repository is part of the jhudsl organization. A personal repository would be associated with a username instead of the organization. --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Update your website's info for syncs/OTTR updates | ||
about: Provide information about your moved/renamed website (which uses the OTTR Website template) so that it can continue to be enrolled in OTTR updates | ||
title: '' | ||
labels: '' | ||
assignees: cansavvy | ||
|
||
--- | ||
|
||
<!-- Remove headings if they are not applicable to the changes/updates you made for your repo--> | ||
|
||
## If the name of your repository was changed ... | ||
|
||
### What was the old name? | ||
<!-- The old/original name of the repo. Ex the name of this repo is OTTR_Template_Website --> | ||
|
||
### What is the new name? | ||
<!-- The new/modified name of the repo. Ex the name of this repo is OTTR_Template_Website --> | ||
|
||
## If the repository was moved ... | ||
|
||
### What was the original username or organization your repository was associated with? | ||
<!-- The old/original name of the username or organization where the new repository was located . Ex this repository is part of the jhudsl organization. A personal repository would be associated with a username instead of the organization. --> | ||
|
||
### What is the new username or organization your repository was associated with? | ||
<!-- The new/modified name of the username or organization where the new repository is located . Ex this repository is part of the jhudsl organization. A personal repository would be associated with a username instead of the organization. --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
name: New content idea | ||
about: Suggest an idea for the website | ||
title: '' | ||
labels: '' | ||
assignees: | ||
|
||
--- | ||
|
||
## Describe the your scope of your content idea | ||
<!-- What will this cover and how does it relate to the current website material? --> | ||
|
||
|
||
## Additional context or resources | ||
<!-- Add any other context or related resources for the content idea? --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: Website Problem Report | ||
about: Create a report to help improve a website | ||
title: [Problem] | ||
labels: bug | ||
assignees: | ||
|
||
--- | ||
|
||
## Describe what is not working with the website | ||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
## Steps to Reproduce | ||
<!-- Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
--> | ||
|
||
## Expected behavior | ||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Screenshots | ||
<!-- If applicable, add screenshots to help explain your problem. --> | ||
|
||
## Additional context | ||
<!-- Add any other context about the problem here. --> |
20 changes: 20 additions & 0 deletions
20
.github/ISSUE_TEMPLATE/website-template-feature-request.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Website Template Feature Request | ||
about: Suggest an idea for the website templates | ||
title: '' | ||
labels: '' | ||
assignees: cansavvy | ||
|
||
--- | ||
|
||
## Is your feature request related to a problem? Please describe. | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
## Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
## Describe alternatives you've considered | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
## Additional context | ||
<!-- Add any other context or screenshots about the feature request here. --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Website Template Problem Report | ||
about: Create a report to help improve the template and its documentation | ||
title: Problem | ||
labels: bug | ||
assignees: cansavvy | ||
|
||
--- | ||
|
||
## Describe what is not working with the template or is unclear in the documentation | ||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
## Please link to the specific website repository you are working on | ||
|
||
## To Reproduce | ||
<!-- Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error --> | ||
|
||
## Expected behavior | ||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Github actions links | ||
<!-- If applicable please link to the Github actions that has failed. --> | ||
|
||
## Screenshots | ||
<!-- If applicable, add screenshots to help explain your problem. --> | ||
|
||
## Additional context | ||
<!-- Add any other context about the problem here. --> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
name: Add new repository to sync | ||
about: Enroll your repository for OTTR updates | ||
title: OTTR Updates Enrollment | ||
labels: '' | ||
assignees: cansavvy | ||
--- | ||
|
||
Added __ repository to sync.yml in order to enroll in OTTR updates. |
47 changes: 47 additions & 0 deletions
47
.github/PULL_REQUEST_TEMPLATE/pull_request_template_general.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
name: New Content or Feature | ||
about: New Content or Feature Update | ||
title: General Update | ||
labels: '' | ||
assignees: | ||
--- | ||
|
||
|
||
<!--This PR Template was modified from https://github.com/AlexsLemonade/OpenPBTA-analysis/blob/master/.github/PULL_REQUEST_TEMPLATE.md--> | ||
|
||
### Purpose/implementation Section | ||
|
||
#### What changes are being implemented in this Pull Request? | ||
|
||
|
||
|
||
#### What was your approach? | ||
|
||
|
||
|
||
#### What GitHub issue does your pull request address? | ||
|
||
|
||
|
||
### Tell potential reviewers what kind of feedback you are soliciting. | ||
|
||
|
||
|
||
### New Content Checklist | ||
|
||
- [ ] New content/page is in an Rmd file with [this kind of format and headers](https://github.com/jhudsl/OTTR_Template_Website/blob/main/editing.Rmd). | ||
|
||
- [ ] Website successfully re-renders and any new content files have been added to the `_site.yml` file. | ||
|
||
- [ ] [Spell check runs successfully](https://www.ottrproject.org/customize-robots.html#Spell_checking)). | ||
|
||
- [ ] Any newly necessary packages that are needed have been added to the [Dockerfile and image](https://www.ottrproject.org/customize-docker.html). | ||
|
||
- [ ] Images are in the [correct format for rendering](https://www.ottrproject.org/writing_content_courses.html#set-up-images). | ||
|
||
- [ ] Every new image has [alt text and is in a Google Slide](https://www.ottrproject.org/writing_content_courses.html#Accessibility). | ||
|
||
- [ ] Each slide is described in the notes of the slide so learners relying on a screen reader can access the content. See https://lastcallmedia.com/blog/accessible-comics for more guidance on this. | ||
|
||
- [ ] The color palette choices of the slide are contrasted in a way that is friendly to those with color vision deficiencies. | ||
You can check this using [Color Oracle](https://colororacle.org/). |
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