Skip to content

Commit 112919c

Browse files
manifestinteractivemanifestinteractive
committed
Updates Include
- [X] Upgraded to latest NPM Dependencies - [X] Updating Documentation - [X] Added better GitHub Workflow Support - [X] Fixed outdated links to external resources
1 parent 9834272 commit 112919c

23 files changed

+1595
-1709
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,52 @@
1-
![Logo](../docs/img/logo.png "Logo")
2-
3-
Thank you for Contributing
1+
Contributing Guide
42
===
53

6-
We want to make it as easy as possible to contribute changes.
4+
Issues & Feature Requests
5+
---
76

8-
Follow the requirements below for __[Creating Issues](https://github.com/sfccdevops/accessibility-tester/issues/new)__ and __[Pull Requests](https://github.com/sfccdevops/accessibility-tester/pull/new)__, to keep everything simple for everyone :)
7+
[![Create Issue](https://img.shields.io/badge/Github-Create_Issue-red.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/sfccdevops/accessibility-tester/issues/new/choose)
98

10-
<img src="https://octodex.github.com/images/dinotocat.png" width="400" />
9+
### Bug Fix
1110

12-
Creating an Issue
13-
---
11+
> We're sorry things are not working as expected, and want to get things fixed ASAP. In order to help us do that, we need a few things from you.
12+
13+
1. Create a [New Issue](https://github.com/sfccdevops/accessibility-tester/issues/new/choose)
14+
2. Enter a Short but Descriptive Title for the Issue
15+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A`
16+
4. Look for the `Labels` section, and select `Bug Report` from the drop down menu
17+
5. Click `Submit new issue` button
18+
19+
### Feature Request
1420

15-
Use the Prepopulated Template that we provide.
21+
> Got an idea for a new feature? We'd love to hear it! In order to get this knocked out, we will need a few things from you.
1622
23+
1. Create a [New Issue](https://github.com/sfccdevops/accessibility-tester/issues/new/choose)
24+
2. Enter a Short but Descriptive Title for the Feature Request
25+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` ( you can delete the `Steps to Duplicate:` section as that does not apply )
26+
4. Look for the `Labels` section, and select `Feature Request` from the drop down menu
27+
5. Click `Submit new issue` button
1728

18-
Creating a Pull Request
29+
Pull Requests
1930
---
2031

21-
Before you can submit a PR, you will need to:
32+
[![Create Pull Request](https://img.shields.io/badge/Github-Create_Pull_Request-blue.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/sfccdevops/accessibility-tester/compare)
33+
34+
### Bug Fix
35+
36+
> Each Bug Fix reported on GitHub should have its own `fix/*` branch. The branch name should be formatted `fix/###-issue-name` where `###` is the GitHub Issue Number, and `issue-name` is a 1-3 word summary of the issue.
37+
38+
1. Checkout latest `develop` branch
39+
2. Pull down the latest changes via `git pull`
40+
3. Create a new branch with the structure `fix/*`, e.g. `fix/123-broken-form`
41+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
42+
5. Tag your new Pull Request with `Ready for Code Review`
43+
44+
### Feature Request
45+
46+
> Each New Feature should reside in its own `feature/` branch. The branch name should be formatted `feature/###-feature-name` where `###` is the GitHub Issue Number, and `feature-name` is a 1-3 word summary of the feature.
2247
23-
1. Make a New Branch off of `master` ( ideally you will name your branch for the issue you are fixing, e,g, `issue-3-fixing-logger` )
24-
2. Commit & Push your New Branch, with a comment like `Fixes #3` to auto trigger a status change for that issue
25-
3. Make your Pull Request into the `master`
26-
4. Set `Reviewers` and `Assignees` to `Peter Schmalfeldt` ( or other project administrator )
27-
5. Choose an appropriate label from the `Labels`
48+
1. Checkout latest `develop` branch
49+
2. Pull down the latest changes via `git pull`
50+
3. Create a new branch with the structure `feature/*`, e.g. `feature/123-mobile-header`
51+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
52+
5. Tag your new Pull Request with `Ready for Code Review`

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Bug Report
2+
description: I would like to Report a Bug
3+
labels: [Bug Report]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the Bug
17+
description: A clear and concise description of what the bug is.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Steps To Reproduce
23+
description: Steps to reproduce the behavior.
24+
placeholder: |
25+
1. Go to ...
26+
2. Click on ...
27+
3. Scroll down to ...
28+
4. See error ...
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Expected Behavior
34+
description: A concise description of what you expected to happen.
35+
validations:
36+
required: false
37+
- type: textarea
38+
attributes:
39+
label: Screenshots
40+
description: If applicable, add screenshots to help explain your problem.
41+
validations:
42+
required: false
43+
- type: textarea
44+
attributes:
45+
label: Environment
46+
description: |
47+
examples:
48+
- **OS**: Ubuntu 20.04
49+
- **Node**: 13.14.0
50+
- **npm**: 7.6.3
51+
value: |
52+
- OS:
53+
- Node:
54+
- npm:
55+
render: markdown
56+
validations:
57+
required: false
58+
- type: textarea
59+
attributes:
60+
label: Additional Context
61+
description: |
62+
Links? References? Anything that will give us more context about the issue you are encountering!
63+
64+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
65+
validations:
66+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request
2+
description: This is a new Feature Request for this project
3+
labels: [Feature Request]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the Problem
10+
description: Is your feature request related to a problem? Please describe.
11+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the Solution
17+
description: Describe the solution you'd like
18+
placeholder: A clear and concise description of what you want to happen.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Alternatives
24+
description: Describe alternatives you've considered
25+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Additional Context
31+
description: |
32+
Add any other context or screenshots about the feature request here.
33+
34+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
35+
validations:
36+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Question
2+
description: I have a Question about this project
3+
labels: [Question]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Question
10+
description: Please Write your Question Below.
11+
validations:
12+
required: true

‎.github/ISSUE_TEMPLATE/requested-change.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Requested Change
2+
description: This is a Requested Change to the project
3+
labels: [Requested Change]
4+
assignees:
5+
- manifestinteractive
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the Problem
10+
description: Is your requested change related to a problem? Please describe.
11+
placeholder: A clear and concise description of what the request is.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the Solution
17+
description: Describe the solution you'd like
18+
placeholder: A clear and concise description of what you want to happen.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Alternatives
24+
description: Describe alternatives you've considered
25+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Additional Context
31+
description: |
32+
Add any other context or screenshots about the feature request here.
33+
34+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
35+
validations:
36+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
1-
#### What's this PR do?
1+
Overview
2+
---
23

3-
_[write_something]_
4+
TEXT
45

5-
#### Where should the reviewer start?
6+
Reviewer
7+
---
68

7-
_[write_something]_
9+
> Where should the reviewer start? How to Test? Background Context? etc ( required )
810
9-
#### How should this be manually tested?
11+
TEXT
1012

11-
_[write_something]_
13+
Checklist
14+
---
1215

13-
#### Any background context you want to provide?
16+
> I have tested each of the following, and they work as expected: ( required )
1417
15-
_[write_something]_
18+
- [ ] Meets [Contributing Guide](https://github.com/sfccdevops/accessibility-tester/blob/develop/.github/CONTRIBUTING.md) Requirements
19+
- [ ] Pulled in the Latest Code from the `develop` branch
20+
- [ ] Works on a Desktop / Laptop Device
1621

17-
#### What are the relevant github issue?
22+
Documentation
23+
---
1824

19-
_[write_something]_
25+
> Screenshots, Attachments, Linked GitHub Issues, etc ( optional )
2026
21-
#### Screenshots (if appropriate)
2227

23-
_[drag_and_drop_here]_
2428

25-
#### What gif best describes this PR or how it makes you feel?
29+
#### What GIF best describes this PR or how it makes you feel?
2630

27-
_[drag_and_drop_something_fun_here]_
28-
29-
#### Definition of Done:
30-
31-
- [ ] You have actually run this locally and can verify it works
32-
- [ ] You have verified that `npm test` passes without issue
33-
- [ ] You have updated the README file (if appropriate)
31+
> Drag & Drop Something Fun Here ( optional )

‎.github/workflows/test.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Node.js CI
2+
on:
3+
push:
4+
branches: [ master ]
5+
pull_request:
6+
branches: [ master ]
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
- name: Install and Test
13+
uses: actions/setup-node@v3
14+
with:
15+
node-version: '14.x'
16+
- run: npm ci
17+
- run: npm test

0 commit comments

Comments
 (0)