Skip to content

Commit

Permalink
docs(commitizen): add commitizen support to repo
Browse files Browse the repository at this point in the history
Added commitizen, as well as a package.json and documentation on how to work with them

docs #1
  • Loading branch information
Melisa Griffin committed Dec 15, 2019
1 parent e02a625 commit 89149c3
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
#Node
package-lock.json

#Dependency Directories
node_modules/
*.pyc

.DS_Store
25 changes: 25 additions & 0 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contribution guide

## Developing ExcitationTool

Thanks for wanting to contribute to the SmartLabGaTech BandExcitation Tool!

Please follow the Rules below when creating a Pull-Request:

## Requirements for Development
- Python: https://www.python.org/
- Commitizen: http://commitizen.github.io/cz-cli/

### Commitizen example
When making your commits, run `git cz`. You will then be prompted to scope your commit correctly. Make sure you also put the correct issue number into the commit.

![git cz](./docs/images/cz-example.png)

This allows the commit messages to look like this:

![commit message example](./docs/images/commit-example.png)

### Rebasing
Always be sure to rebase with Master

## Coming Soon: CI/CD
1 change: 1 addition & 0 deletions cz/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
//TODO: Figure out if we need scopes
Binary file added docs/images/commit-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cz-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "ExcitationTool",
"version": "0.1.0",
"description": "A tool developed by the Smart Materials Advanced Research and Technology (SMART) lab at the Georgia Institute of Technology. This tool expands the functionality of any Atomic Force Microscope (AFM) to allow for band excitation characterization of samples.",
"devDependencies": {
"cz-conventional-changelog": "^3.0.2",
"cz-customizable": "^5.5.3"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
},
"cz-customizable": {
"config": "./cz/config.js"
}
}
}

0 comments on commit 89149c3

Please sign in to comment.