docs: Add guidance for PR titles and testing in an application #1028
Conversation
suzubara
requested review from
ahobson,
brandonlenz,
gidjin,
haworku,
sarboc,
SirenaBorracha and
tinyels
as code owners
suzubara
added
the
type: documentation
docs/contributing.md
Outdated
| ``` | ||
|
|
||
| #### `type`: | ||
|
|
There was a problem hiding this comment.
Should we also include ! or BREAKING_CHANGE in the PR title as well if its a breaking change since we squash
There was a problem hiding this comment.
Also this level of detail for contributors feels like a lot. Makes me wish for something like the form described here so maintainers could carry the bulk of this work.
There was a problem hiding this comment.
I agree, although since only Trussels are able to merge PRs right now maybe it's okay for now? definitely something to think about moving forward..
suzubara
force-pushed
the
sr-doc-updates
branch
from
47d7e56 to
44b5af5
Compare
|
I pushed up some minor changes, including moving the whole "commit guidelines" section to the end of the contributing doc. @haworku I'm hoping that will indicate that this is more relevant to the end of the contributing workflow, and since only Truss org members can merge PRs it isn't really relevant to external contributors for now. |
## [1.15.0](1.14.0...1.15.0) (2021-04-12) ### Features * Identifier component ([#1044](#1044)) ([e79bc87](e79bc87)) * StepIndicator component ([#1047](#1047)) ([d61988e](d61988e)) * TimePicker component ([#1082](#1082)) ([c7bfdee](c7bfdee)) * Update to USWDS 2.9.0 ([#1048](#1048)) ([3859eea](3859eea)) ### Documentation & Examples * Add guidance for PR titles and testing in an application ([#1028](#1028)) ([be3bed4](be3bed4))
* Add docs with more info on commit message guidelines * Add section about application testing to docs * Fix links * Minor updates to ordering
## [1.15.0](1.14.0...1.15.0) (2021-04-12) ### Features * Identifier component ([#1044](#1044)) ([e79bc87](e79bc87)) * StepIndicator component ([#1047](#1047)) ([d61988e](d61988e)) * TimePicker component ([#1082](#1082)) ([c7bfdee](c7bfdee)) * Update to USWDS 2.9.0 ([#1048](#1048)) ([3859eea](3859eea)) ### Documentation & Examples * Add guidance for PR titles and testing in an application ([#1028](#1028)) ([be3bed4](be3bed4))
Summary
I added some documentation to clarify the possible types and other parameters to use for our standard PR/commit format.
I also wrote some docs about how to test ReactUSWDS changes in an application, and added a note to the PR template to remind PR authors to do this testing when applicable.