-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added some developer documentation
- Loading branch information
1 parent
50e4039
commit 50c096a
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Prereqs | ||
You will need to install [nodejs](https://nodejs.org/en). `npm` comes with `nodejs` and is the package manager needed to install a development tool called `git-conventional-commits` in the repo on your computer. I use `NVM` to manage `nodejs`. I do the following to install NVM and then nodejs: | ||
|
||
```cmd | ||
REM Use the windows package manager to get NVM | ||
winget install --id CoreyButler.NVMforWindows | ||
REM Installs the Long Term Service version of nodejs | ||
nvm install lts | ||
REM Sets the version of nodejs to use | ||
nvm use lts | ||
REM Check that npm is available and what version | ||
npm -v | ||
``` | ||
|
||
# Setup | ||
1. Clone the repo. | ||
2. Run `post-clone-script.sh`. | ||
3. Develop. | ||
4. Commit using conventional commits. | ||
|
||
# Conventional commits | ||
This repos uses conventional commits. The format is | ||
|
||
<pre> | ||
<b><a href="#types"><type></a></b>: <b><a href="#subject"><subject></a></b> | ||
<sub>empty separator line</sub> | ||
<b><a href="#body"><optional body></a></b> | ||
<sub>empty separator line</sub> | ||
<b><a href="#footer"><optional footer></a></b> | ||
</pre> | ||
|
||
See [../git-conventional-commits.yaml](../git-conventional-commits.yaml) for the configuration of the conventional commits. The important thing to find in the configuration is the commit `type`. The configuration was generate using the [git-conventional-commits](/~https://github.com/qoomon/git-conventional-commits) tool. | ||
|
||
Example commit message: | ||
|
||
``` | ||
chore: adding conventional commits | ||
``` | ||
|
||
|
||
[More Info on Conventional Commit Messages here](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13) |