generated from hackforla/.github-hackforla-base-repo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
0 parents
commit c8b8227
Showing
21 changed files
with
942 additions
and
0 deletions.
There are no files selected for viewing
18 changes: 18 additions & 0 deletions
18
.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.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: Add project logo or image to your main repository | ||
about: Simple action that will make it possible to add project to hackforla.org website | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
By adding the project's logo/image to your project's primary repository, we will be able to dynamically deliver up to date information about your project to the hackforla.org website. Also when people add the link to the repository in LinkedIn or Slack, or other social media it will automatically use the image as well as the description, improving the link's chances of getting clicked on. | ||
|
||
### Action Items | ||
Add project's logo/image to your primary Github repository using the instructions below. You should use the same image as is on the hackforla.org website, or if another image is desired, please replace both with the same image. | ||
|
||
### Resources/Instructions | ||
Tip: Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at 640 by 320 pixels. | ||
Read Github's [Customizing your repository's social media preview](https://help.github.com/en/articles/customizing-your-repositorys-social-media-preview) |
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: Blank Issue | ||
about: Consistent formatting make Issues concise and easy to navigate | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
REPLACE THIS TEXT -Text here that clearly states the purpose of this issue in 2 sentences or less. | ||
|
||
### 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. |
27 changes: 27 additions & 0 deletions
27
...TE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.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,27 @@ | ||
--- | ||
name: Control what appears when you paste your sites link in social media sites | ||
about: Add Open Graph Markup tags to header | ||
title: Control what appears when you paste your sites link in social media sites | ||
labels: enhancement, question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
When your website is shared on slack, facebook, twitter, etc. It should automatically display with an image and title instead of just the URL. | ||
|
||
### Action items | ||
Identify what to put in the following fields: | ||
og:url | ||
g:type | ||
og:title | ||
og:description | ||
og:image | ||
og:type (optional) | ||
og:local (option) | ||
using the standards set forth in the instructions. | ||
|
||
Add content to header and test with the tool provided in the instructions. | ||
|
||
### Instructions | ||
[A Guide to Sharing for Webmasters](https://developers.facebook.com/docs/sharing/webmasters#markup) |
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,45 @@ | ||
--- | ||
name: 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 | ||
This issue tracks the agenda for our weekly meetings | ||
|
||
#### Issue Template | ||
``` | ||
## [Date ] Meeting Agenda | ||
### Prework to prep for meeting | ||
- [ ] # | ||
### Recurring items: Happens on the ________ meeting | ||
- [ ] review any issues that are in the [new issue approval column] | ||
- [ ] Accountability and Support Check. | ||
- [ ] Review assignments for each Team member | ||
- [ ] [Name of Person] | ||
- [ ] finish adding labels to the issue that are still missing them (see audit links above) | ||
- [ ] review issues with [epic label] and define how to break down further | ||
- [ ] Review to see if there are any members to Onboard or Offboard | ||
- [ ] # | ||
### New Items | ||
- [ ] | ||
- [ ] Carry over Items to next meeting that don't get addressed | ||
### FYIs | ||
- | ||
### Notes from Meeting | ||
### Task Items | ||
``` | ||
|
||
### Links to other agenda issues for your team | ||
(so that you can easily post on their agendas items that come up at yours) | ||
|
||
### Previous Meetings (link to each comment with the date) |
30 changes: 30 additions & 0 deletions
30
.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.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,30 @@ | ||
--- | ||
name: Create project card for [project name] | ||
about: Gather information to add this project to HackforLA's website | ||
title: '' | ||
labels: documentation, good first issue, question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Provide collateral for the HackforLA website | ||
|
||
### Action Items | ||
- [ ] Gather items | ||
- [ ] 600 x 400 image | ||
- [ ] Alt image text | ||
- [ ] 1500 x 700 hero image (please do not put project title on hero image) | ||
- [ ] Alt image text | ||
- [ ] Name of project | ||
- [ ] A blurb about your project | ||
- [ ] Links (github, slack channel url, Testing Site, Live Site, etc.) | ||
- [ ] Any resources for a Getting Started link (a link to a wiki, readme(s) or both) | ||
- [ ] What you are looking for skills wise | ||
- [ ] Partner(s) | ||
- [ ] Location | ||
- [ ] Status | ||
- [ ] Add project Card to website | ||
|
||
### Resources/Instructions | ||
See project cards on the hackforla.org website for examples |
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,10 @@ | ||
--- | ||
name: Custom issue template | ||
about: Describe this issue template's purpose here. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
|
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: Feature request | ||
about: Suggest an idea for this project | ||
title: 'Feature Suggestion: ' | ||
labels: documentation, product | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Overview | ||
Please write a user story for this feature suggestion in the following format: As a ______, I want to do X for Y reason and replace this text with it. | ||
|
||
### Action Items | ||
- [ ] Define your Feature Suggestion | ||
- [ ] What is the feature you are suggesting? | ||
- [ ] Is this feature urgent | ||
- [ ] if so why? | ||
- [ ] How long do you expect it take to implement this issue? | ||
- [ ] Who is needed to implement this feature (Could you implement it yourself?) | ||
- [ ] Design | ||
- [ ] Front End | ||
- [ ] Back End | ||
- [ ] Database | ||
- [ ] What problem does this feature solve? | ||
- [ ] What technologies are needed for this feature? | ||
|
||
### Resources/Instructions | ||
If there is a website which has documentation that helps with this issue provide the link(s) here: | ||
|
||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
20 changes: 20 additions & 0 deletions
20
.github/ISSUE_TEMPLATE/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: '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/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: '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/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: '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: '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. |
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: '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 |
Oops, something went wrong.