feat: added setup for conventional commits

Author: nickreynke

.gitignore

@@ -114,3 +114,92 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/

.nvmrc

@@ -0,0 +1 @@
+12.16.1

MANIFEST.in

@@ -18,3 +18,9 @@ recursive-exclude gedcom *.md
 
 # Include GEDCOM test files
 include tests/files/*.ged
+
+# Exclude Node related files
+exclude .nvmrc
+exclude commitlint.config.js
+exclude package.json
+exclude package-lock.json

README.md

@@ -62,6 +62,27 @@ the `repository-url` is `https://upload.pypi.org/legacy/`.
 >
 > `pipenv run twine upload --repository-url https://upload.pypi.org/legacy/ dist/*`
 
+## Contribution
+
+1. Clone the repo
+1. Make your changes
+1. (Write appropriate tests within `tests/`)
+1. Commit using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+1. [Open a pull request](https://github.com/madprime/python-gedcom/compare)
+1. When checks for the PR fail consider making changes so that the checks pass
+
+### Git: Conventional Commits
+
+Git committing is done using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) with NPM.
+
+Consider installing node packages with [NVM](https://github.com/nvm-sh/nvm) and start committing with `npm run commit`.
+Git hooks installed via [Husky](https://github.com/typicode/husky) will do the rest.
+
+How to install:
+
+1. Use Node version `12.16.1` (or use [NVM](https://github.com/nvm-sh/nvm) and run `nvm use`)
+1. Run `npm install` and then `npm run commit` to commit your changes
+
 ## History
 
 This module was originally based on a GEDCOM parser written by 

commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional']
+};