From e6b2cbda03ea794d8a9ed17c233e0743041beae2 Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Thu, 16 Sep 2021 12:10:36 -0700 Subject: [PATCH] docs(dev): start a set of "dev" docs Initially this creates a top-level "dev" directory to hold documents pertaining to the development, as opposed to the usage, of hyper. For a first doc, it splits out the commit guidelines to its own file. cc #2586 --- CONTRIBUTING.md | 77 +------------------------------------------------ dev/COMMITS.md | 65 +++++++++++++++++++++++++++++++++++++++++ dev/README.md | 3 ++ 3 files changed, 69 insertions(+), 76 deletions(-) create mode 100644 dev/COMMITS.md create mode 100644 dev/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eacb0e70..ba4b4213 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,79 +7,4 @@ You want to contribute? You're awesome! Don't know where to start? Check the [li ## Pull Requests -When submitting a Pull Request, please have your commits follow these guidelines: - -### Git Commit Guidelines - -These guidelines have been copied from the [AngularJS](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) -project. - -We have very precise rules over how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to **generate the change log**. - -#### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type**, a **scope** and a **subject**: - -``` -(): - - - -