Skip to content

Commit 5d4752d

Browse files
starryeyez024kylebuch8
authored andcommitted
dev-pull-request-template add testing instructions to PR template (#463)
* dev-pull-request-template add testing instructions to PR template * Update pull_request_template.md removed "updated with master branch", this is enforced by github * move PR template up to root of .github folder * Add alert for PFE contrib list * Add discovery template, CHANGELOG, and add those notes to the pull request template * Update changelog with notes from release tags * Update pull_request_template.md
1 parent 73a5e60 commit 5d4752d

File tree

4 files changed

+156
-23
lines changed

4 files changed

+156
-23
lines changed

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

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

.github/pull_request_template.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## Title of this pull request
2+
3+
* Link to discovery documentation (should contain all the planning and requirements for this work):
4+
- See the `DISCOVERY.md` template at the root of the project
5+
* Link(s) to demo pages where this element can be viewed:
6+
7+
---
8+
9+
### What has changed and why
10+
Summarize files edited as part of this MR along with a brief description of what was changed/why.
11+
12+
*
13+
14+
### Testing instructions
15+
Be sure to include detailed instructions on how your update can be tested by another developer.
16+
17+
1.
18+
19+
#### Browser requirements
20+
Your component should work in all of the following environments:
21+
22+
- [ ] Latest 2 versions of Edge
23+
- [ ] Internet Explorer 11 (should be useable, not pixel perfect)
24+
- [ ] Latest 2 versions of Firefox (one on Mac OS, one of Windows OS)
25+
- [ ] Firefox 60.7.2 (or latest version for Red Hat Enterprise Linux distribution)
26+
- [ ] Latest 2 versions of Chrome (one on Mac OS, one of Windows OS)
27+
- [ ] Latest 2 versions of Safari
28+
- [ ] Galaxy S9 Firefox
29+
- [ ] iPhone X Safari
30+
- [ ] iPad Pro Safari
31+
- [ ] Pixel 3 Chrome
32+
33+
Your repository infrastructure updates should work for at least:
34+
- [ ] Node v8.x
35+
- [ ] NPM v7.x
36+
37+
### Ready-for-merge Checklist
38+
39+
- [ ] Expected files: all files in this pull request are related to one feature request or issue (no stragglers)?
40+
- [ ] Did automated tests pass?
41+
- [ ] Did browser testing pass?
42+
- [ ] Did you update or add any necessary documentation (README.md, WHY.md, etc.)?
43+
- [ ] Was this feature demo'd and the design review approved?
44+
- [ ] Did it get a LGTM *after the last commit*?
45+
- [ ] Did you update the CHANGELOG.md file with a summary of this update?
46+
47+
48+
**Be sure to share your updates with the [[email protected]](mailto:[email protected]) mailing list!**
49+

CHANGELOG-prerelease.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
## Prerelease 18 ( TBD )
2+
Tag: [v1.0.0-prerelease.18](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.18)
3+
4+
-
5+
6+
## Prerelease 17 ( 2019-06-24 )
7+
Tag: [v1.0.0-prerelease.17](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.17)
8+
9+
- [1b92821d](https://github.com/patternfly/patternfly-elements/commit/1b92821de18f8c0c49a5397a8dc29b19dcbcb482) adding a check in pfe-tab-panel to see if associated tab is selected when panel is initialized ([#432](https://github.com/patternfly/patternfly-elements/pull/432))
10+
- [ae21a66b](https://github.com/patternfly/patternfly-elements/commit/ae21a66b090df5ac6a7f4015e0d0d6f487b00340) Update README.md ([#426](https://github.com/patternfly/patternfly-elements/pull/426))
11+
- [3796210b](https://github.com/patternfly/patternfly-elements/commit/3796210b038497f010356d97f92637987218ab8a) Adding 2 demo scripts to the npm package ([#430](https://github.com/patternfly/patternfly-elements/pull/430))
12+
13+
## Prerelease 16 ( 2019-05-31 )
14+
Tag: [v1.0.0-prerelease.16](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.16)
15+
16+
- [4a606dbd](https://github.com/patternfly/patternfly-elements/commit/4a606dbd4baf53478bf94780fee0dcea6624fcfc) moving this.button initialization to the constructor ([#419](https://github.com/patternfly/patternfly-elements/pull/419))
17+
- [f8f9004f](https://github.com/patternfly/patternfly-elements/commit/f8f9004f81331abdccbd8f9fb76739290c0b0ef1) pfe-markdown element ([#358](https://github.com/patternfly/patternfly-elements/pull/358))
18+
19+
## Prerelease 15 ( 2019-05-28 )
20+
Tag: [v1.0.0-prerelease.15](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.15)
21+
22+
- [5d6ca9e](https://github.com/patternfly/patternfly-elements/commit/5d6ca9e5441db5e5416612643122c62b2cc84d5a) add meta viewport tag to pfe-content-set demo ([#415](https://github.com/patternfly/patternfly-elements/pull/415))
23+
- [ee6fde4](https://github.com/patternfly/patternfly-elements/commit/ee6fde41c4859023273226439b9c045cea46418c) adding a slotchange listener and adding tests ([#407](https://github.com/patternfly/patternfly-elements/pull/407))
24+
- [bf8790f](https://github.com/patternfly/patternfly-elements/commit/bf8790f62722c765c20e4913def79b062ecaa3d7) Card feature updates ([#312](https://github.com/patternfly/patternfly-elements/pull/312))
25+
- [5d1fa72](https://github.com/patternfly/patternfly-elements/commit/5d1fa72949f0ed83bbb0752bb42ebd7637b9efb3) reset surface-border color to #d2d2d2
26+
- [e8260e5](https://github.com/patternfly/patternfly-elements/commit/e8260e5740275a888d142dbb001a736ae311051f) PFE-accordion border fixes
27+
- [84dbf03](https://github.com/patternfly/patternfly-elements/commit/84dbf031027dcca589dc6bf8176956c2b6ab305c) Pfe docs status ([#408](https://github.com/patternfly/patternfly-elements/pull/408))
28+
- [827aa51](https://github.com/patternfly/patternfly-elements/commit/827aa5199f2891f8b92e4765c6451a49ae853a94) Update Storybook utils to support self-closing tag ([#411](https://github.com/patternfly/patternfly-elements/pull/411))
29+
- [393098c](https://github.com/patternfly/patternfly-elements/commit/393098c258fb3ad8788f4e22413511b490aef93b) Rename PR template directory & file in hopes that github will use them ([#410](https://github.com/patternfly/patternfly-elements/pull/410))
30+
31+
## Prerelease 14 ( 2019-04-30 )
32+
Tag: [v1.0.0-prerelease.14](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.14)
33+
34+
- Version bumps from release release/v1.0.0-prerelease.13 ([#398](https://github.com/patternfly/patternfly-elements/pull/398))
35+
- Adding a mutationobserver to pfe-tabs ([#402](https://github.com/patternfly/patternfly-elements/pull/402))
36+
- Adding a mutationobserver to pfe-accordion ([#401](https://github.com/patternfly/patternfly-elements/pull/401))
37+
38+
## Prerelease 13 ( 2019-04-23 )
39+
Tag: [v1.0.0-prerelease.13](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.13)
40+
41+
- Pt 2: Storybook updates ([#277](https://github.com/patternfly/patternfly-elements/pull/277))
42+
- Documenting release steps ([#379](https://github.com/patternfly/patternfly-elements/pull/379))
43+
- Add release automation script ([#399](https://github.com/patternfly/patternfly-elements/pull/399))
44+
45+
## Prerelease 12 ( 2019-04-22 )
46+
Tag: [v1.0.0-prerelease.12](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.12)
47+
48+
- On branch checkout, look for leftover elements from other branches ([#394](https://github.com/patternfly/patternfly-elements/pull/394))
49+
- Fix the directory of the hugo-check.sh call ([#393](https://github.com/patternfly/patternfly-elements/pull/393))
50+
- Add some additional information to each package file ([#382](https://github.com/patternfly/patternfly-elements/pull/382))
51+
52+
## Prerelease 11 ( 2019-04-02 )
53+
Tag: [v1.0.0-prerelease.11](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.11)
54+
55+
- Removing duplicate has_slot function in PFElement ([#322](https://github.com/patternfly/patternfly-elements/pull/322))
56+
- Change Spandx port to auto ([#354](https://github.com/patternfly/patternfly-elements/pull/354))
57+
- Add autoprefixer tooling to the repo ([#334](https://github.com/patternfly/patternfly-elements/pull/334))
58+
59+
## Prerelease 10 ( 2019-03-26 )
60+
Tag: [v1.0.0-prerelease.10](https://github.com/patternfly/patternfly-elements/releases/tag/v1.0.0-prerelease.10)
61+
62+
- Update accordion styles ([#359](https://github.com/patternfly/patternfly-elements/pull/359))
63+
- Band layout tweaks ([#336](https://github.com/patternfly/patternfly-elements/pull/336))
64+
- Resolve grid gap in band layout ([#361](https://github.com/patternfly/patternfly-elements/pull/361))
65+
- Documentation updates ([#368](https://github.com/patternfly/patternfly-elements/pull/368))
66+
- Prefix pfe-avatar attributes ([#371](https://github.com/patternfly/patternfly-elements/pull/371))
67+
- Remove CP-theme ([#362](https://github.com/patternfly/patternfly-elements/pull/362))

DISCOVERY.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Project name
2+
_NOTE:_ Please convert this file to WHY.md and save it in the folder for the elements it references (i.e., `elements/pfe-cta/WHY.md`).
3+
4+
| | |
5+
| --- | --- |
6+
| **Brief description of the project** | |
7+
| **Design wireframes / mock-ups** | |
8+
| **Relavant project management links** | |
9+
10+
## MVP Requirements
11+
This project's primary goal is to...
12+
13+
## Questions to answer
14+
- What **existing** components do we need to **update** to accomplish this project's main goal?
15+
- What **new** components do we need to accomplish this project's main goal?
16+
1. Content components:
17+
2. Container components:
18+
3. Combo components:
19+
20+
## Notes about styles
21+
* [Check w/ Design System Collaborative for Designs](https://github.com/patternfly/patternfly-unified-design-kit/projects/1)
22+
* [Check PF4](https://docs.google.com/spreadsheets/d/1P9iYwguDy2EnIS-Iw5ynX1Dn6FdKOR8GeZNaXGI_LNA/edit#gid=289588122)
23+
24+
The styles for this component should...
25+
26+
## Accessibility requirements
27+
As a screen-reader user, this component should...
28+
29+
As a sighted keyboard user, this component should...
30+
31+
## Semantics / SEO requirements
32+
From a semantic HTML mindset, this component should...
33+
34+
As a search-engine, this component should...
35+
36+
## Features to include if there is time
37+
If there is time, these features are nice-to-haves.
38+
39+
## Out-of-scope // @TODO later
40+
These are some things we would like to add later to enhance this component.

0 commit comments

Comments
 (0)