generated from hackforla/.github-hackforla-base-repo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
64 changed files
with
11,633 additions
and
5,396 deletions.
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,19 @@ | ||
--- | ||
name: A - Blank Issue | ||
about: Consistent formatting make Issues concise and easy to navigate | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
REPLACE THIS TEXT -This should be in the form of a user story and why we are doing this. We need to do x for y reason. | ||
|
||
### Action Items | ||
REPLACE THIS TEXT -If this is the beginning of the task this is most likely something to be researched and documented. | ||
|
||
REPLACE THIS TEXT -If the issue has already been researched, and the course of action is clear, this will describe the steps. However, if the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task. | ||
|
||
### Resources/Instructions | ||
REPLACE THIS TEXT -If there is a website which has documentation that helps with this issue provide the link(s) here. |
18 changes: 0 additions & 18 deletions
18
.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md
This file was deleted.
Oops, something went wrong.
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,17 @@ | ||
--- | ||
name: B - Update Team Roster | ||
about: Provides new team members a link to team roster to input their information | ||
title: '' | ||
labels: documentation, good first issue, question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Rolling Roster of Team Participants. | ||
|
||
### Action Items | ||
Add or update your personal info to the team roster. | ||
|
||
### Resources/Instructions | ||
ADD URL TO TEAM ROSTER 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
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: C - Create Agenda | ||
about: Assign issue to all team members day after meetup in prep for next meetup | ||
title: '' | ||
labels: documentation, help wanted, question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Gather all items team members want to propose for this weeks' agenda. | ||
|
||
### Action Items | ||
Add comment to this issue with your proposed agenda item. if item warrants an issue of its own please start a [new issue](https://github.com/hackforla/tdm-calculator/issues) |
20 changes: 20 additions & 0 deletions
20
.github/ISSUE_TEMPLATE/c---update-content-for-readme-file.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: C - Update Content for ReadMe file | ||
about: Instructions for revising the README.md file inside this repository | ||
title: '' | ||
labels: documentation, good first issue, help wanted, question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
We need to have a working READme file to easily on-board new team members. | ||
|
||
### Action Items | ||
- [ ] Add the following information as a comment to this issue: | ||
- [ ] Identify what information needs to be collected. | ||
- [ ] Identify who holds each piece of information. | ||
- [ ] Collect information. | ||
|
||
### Resources/Instructions | ||
PUT LINK TO README.md FILE HERE |
27 changes: 0 additions & 27 deletions
27
...TE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md
This file was deleted.
Oops, something went wrong.
26 changes: 0 additions & 26 deletions
26
.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md
This file was deleted.
Oops, something went wrong.
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
20 changes: 20 additions & 0 deletions
20
.github/ISSUE_TEMPLATE/z---lighthouse--accessibility---forms.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: 'Z - Lighthouse: Accessibility - Forms' | ||
about: Instructions for creating or improving forms to make them accessible when visitors | ||
use screen readers AKA Form <input> elements must have labels | ||
title: 'Lighthouse: Accessibility - Forms' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
In order for your sites form(s) to be usable by visitors using screen readers all the form <input> elements need labels. There are specific details and exceptions, which can be found in the instructions below. | ||
|
||
### Action Items | ||
*If your site already has forms* review the instructions and document the changes needed to bring your form(s) into WCAG compliance, by commenting on this issue. | ||
*If your site does not have forms* review the instructions and design new forms using the WCAG standards. | ||
|
||
### Instructions | ||
Deque University | ||
https://dequeuniversity.com/rules/axe/3.2/label |
19 changes: 19 additions & 0 deletions
19
.github/ISSUE_TEMPLATE/z---lighthouse--accessibility---links.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,19 @@ | ||
--- | ||
name: 'Z - Lighthouse: Accessibility - Links' | ||
about: AKA Links must have discernible text | ||
title: 'Lighthouse: Accessibility - Links' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
The formatting of links can make them readable or unreadable by screen readers. Which includes creating programmatic events for links without making them device specific (e.g., onfocus() instead of onmouseover(), etc.), and other ways of making sure all links are visible by screen readers. | ||
|
||
### Action Items | ||
*If your site already has links* review the instructions and document the changes needed to bring your link(s) into WCAG compliance, by commenting on this issue. | ||
*If your site does not have links yet* review the instructions and design all new links using the WCAG standards. | ||
|
||
### Instructions | ||
Deque University | ||
https://dequeuniversity.com/rules/axe/3.2/link-name |
18 changes: 18 additions & 0 deletions
18
.github/ISSUE_TEMPLATE/z---lighthouse--cross-origin-destinations-are-unsafe.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,18 @@ | ||
--- | ||
name: 'Z - Lighthouse: Cross-origin destinations are unsafe' | ||
about: Instructions for addressing the cross-origin linking vulnerabilities | ||
title: 'Lighthouse Issue: Cross-origin destinations are unsafe' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Links to cross-origin destinations are unsafe both from a security and performance perspective. | ||
|
||
### Action Item | ||
Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in [cross-origin destinations are unsafe] | ||
(https://developers.google.com/web/tools/lighthouse/audits/noopener) . | ||
|
||
## Summary of instructions | ||
When using *target=_blank* also adding *rel="noopener"* to the tag ensures that new page runs in a separate process. |
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,27 @@ | ||
--- | ||
name: 'Z - Lighthouse: How To' | ||
about: Provides overview of how to use Lighthouse and links to additional resources | ||
title: 'Lighthouse: How To' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, and more. Hack For LA recommends that you run the tests and evaluate what changes you might want to make on your website to improve performance and accessability. | ||
|
||
### How To Use | ||
Lighthouse is in the Audits panel of the Chrome DevTools. To run a report: | ||
|
||
1. Download Google Chrome for Desktop. | ||
2. In Google Chrome, go to the URL you want to audit. You can audit any URL on the web. | ||
3. Open Chrome DevTools. | ||
4. Click the Audits tab. | ||
5. Click Perform an audit. DevTools shows you a list of audit categories. Leave them all enabled. | ||
6. Click Run audit. After 60 to 90 seconds, Lighthouse gives you a report on the page. | ||
|
||
For more information go to : | ||
https://developers.google.com/web/tools/lighthouse/ | ||
|
||
### Tip | ||
You will want to re-run lighthouse on any code changes before integrating them into your site. Sometimes the specific suggestions it makes, do not actually result in improved performance or can actually harm performance. |
18 changes: 18 additions & 0 deletions
18
.github/ISSUE_TEMPLATE/z---lighthouse--image-optimization.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,18 @@ | ||
--- | ||
name: 'Z - Lighthouse: Image Optimization' | ||
about: Instructions for optimizing images | ||
title: 'Lighthouse: Image Optimization' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
When you run the lighthouse review it may suggest some specific image optimizations such as choosing another image format and making those changes may or may not improve your sites actual performance. | ||
|
||
### Action Items | ||
Run lighthouse on a local version of the website and then apply suggested changes and retest locally before determining if you want to keep the changes. | ||
|
||
### Instructions/Resources | ||
Google's Tools for Web Developers: [Optimize Images](https://developers.google.com/web/tools/lighthouse/audits/optimize-images) | ||
Read [closed issue #111](https://github.com/hackforla/website/issues/111) from when HackforLA.org did our audit, to see why we decided not to do the image optimization |
17 changes: 17 additions & 0 deletions
17
.github/ISSUE_TEMPLATE/z---wave-chrome-extension--accessibility-review.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,17 @@ | ||
--- | ||
name: 'Z - Wave Chrome Extension: Accessibility review' | ||
about: Describe this issue template's purpose here. | ||
title: 'Wave Chrome Extension: Accessibility review' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
|
||
#### Action Items | ||
1. add [WAVE chrome extension](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh) | ||
2. visit site | ||
3. click the extension and review the red flags. | ||
4. Run the same steps for the development site (localhost). Ensure that the chrome extension has the "Allow access to file URLs" enabled. | ||
5. Document all suggested changes in the comments. |
23 changes: 23 additions & 0 deletions
23
.github/ISSUE_TEMPLATE/z---which-accessibility-testing-tool-should-you-use-.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,23 @@ | ||
--- | ||
name: Z - Which accessibility testing tool should you use? | ||
about: There are a lot of tools, this issue has a list of our favorites and links | ||
to more | ||
title: Which accessibility testing tool should you use? | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
There are more than 100 accessibility testing tools. Figuring out which ones to use can be a black hole. For guidance we recommend this article: [Which accessibility testing tool should you use?](https://medium.com/pulsar/which-accessibility-testing-tool-should-you-use-e5990e6ef0a) | ||
|
||
### Summary of Article | ||
The author recommends using the tools in the following order fixing as you go along, since no one tool catches all the relevant issues | ||
|
||
[aXe](https://www.deque.com/axe/) | ||
[SiteImprove](https://chrome.google.com/webstore/detail/siteimprove-accessibility/efcfolpjihicnikpmhnmphjhhpiclljc) | ||
[Tenon](https://tenon.io/) | ||
[WAVE](https://wave.webaim.org/extension/) | ||
[Lighthouse](https://developers.google.com/web/tools/lighthouse/#devtools) | ||
|
||
But if you want to test your site with other tools, here is a bigger [list](https://www.w3.org/WAI/ER/tools/) |
Oops, something went wrong.