From 1da548cb224aed511849340443cd9ed935455f8c Mon Sep 17 00:00:00 2001 From: Suzanne Rozier Date: Thu, 18 Mar 2021 12:37:25 -0500 Subject: [PATCH 1/4] Add docs with more info on commit message guidelines --- README.md | 11 +++++++- docs/contributing.md | 61 +++++++++++++++++++++++++++++++++++++++++--- package.json | 18 +++++++++---- 3 files changed, 80 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f6613e80bb..98f96a6fc3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # @trussworks/react-uswds + + [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) + [![npm version](https://img.shields.io/npm/v/@trussworks/react-uswds)](https://www.npmjs.com/package/@trussworks/react-uswds) @@ -114,6 +117,12 @@ Are you a Trussel and new to this project? Check out our [on & offboarding guide This repository is governed by the [Contributor Covenant](./CODE_OF_CONDUCT.md) +### Quick links: + +- [Commit Guidelines](./docs/contributing.md#before-you-start:-commit-guidelines) +- [Adding New Components](./docs/adding_new_components.md) +- [Releasing](./docs/releasing.md) + ## License [Copyright 2021, TrussWorks, Inc.](./LICENSE) @@ -162,4 +171,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/docs/contributing.md b/docs/contributing.md index 2fe096a735..aafb648f76 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -48,11 +48,64 @@ These should all be run from within the project directory. ## Development -### Before You Start +### Before You Start: Commit Guidelines -Make sure you understand the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. **All pull requests opened into `main` must have a title that follows the [conventional commits spec](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)** This generates an automated changelog entry and is later used to determine versioning for release. It is required to merge. +Make sure you understand the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. **All pull requests opened into `main` must have a title that follows the [conventional commits spec](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)**. This generates an automated changelog entry and is later used to determine versioning for release. It is required to merge. -### Pull Requests +The format for PR titles is: + +``` +(scope): + + + +