Skip to content

Commit

Permalink
Add PR template and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ashley-hebler committed Aug 2, 2019
1 parent 823ad96 commit e401a23
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#### What's this PR do?

##### Classes added (if any)
- c-class-1
##### Classes removed (if any)
- old_class


#### Why are we doing this? How does it help us?



#### How should this be manually tested?
`yarn dev`

See: [your-link](http://localhost:3000/)


#### Does this introduce a breaking change where queso-ui is used in the wild? If so, is there a relevant branch/PR to accompany this release?




#### TODOs / next steps:

* [ ] *your TODO here*
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,24 @@ Make sure you're authenticated for npm publishing.
1. `npm login` - then follow the prompts
2. `npm run release` - There's a [bug](https://github.com/sindresorhus/np/issues/420#issuecomment-499273013) in the `np` publishing tool we use where `yarn` commands don't seem to work.

### Semantic versioning
The npm helper we use for versioning simplifies matching version numbers with the various `MAJOR`, `MINOR`, `PATCH` increment types. For guidance on what type of release you're making, refer to [https://semver.org/](https://semver.org/)

Generally, you could base your increment type on the following list:

- MAJOR version = CSS changes that visually break layouts where `queso-ui` is used on production
- MINOR version = CSS changes that have no visual effect on production
- PATCH version = CSS changes that fix a previous bug introduced on production or in development

### Steps to test breaking changes:
1. Publish these changes on npm: `npm run release`. Copy the version number.
2. Create a new branch in the repo in question.
3. `yarn add @texastribune/queso-ui@VERSION`
4. Compile the CSS
5. Scan the various places where queso-ui is used. At the time of writing, the following pages heavily rely upon this CSS so be sure to check those if you're deprecating/changing classes.
* [ ] [/podcasts](http://local.texastribune.org:8000/podcasts)
* [ ] [/support-us/donors-and-members](http://local.texastribune.org:8000/support-us/donors-and-members)
* [ ] [/newsletters/slug](http://local.texastribune.org:8000/newsletters/tribweek)


## Features/Wishlist
Expand Down

0 comments on commit e401a23

Please sign in to comment.