Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 904 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 904 Bytes

Python Gedcom Parser: Contribution Guideline

  1. Clone the repo
  2. Make your changes
  3. (Write appropriate tests within tests/)
  4. Commit using conventional commits
  5. Open a pull request
  6. When checks for the PR fail consider making changes so that the checks pass

About Conventional Commits

Git committing is done using conventional commits with NPM.

Consider installing node packages with NVM and start committing with npm run commit. Git hooks installed via Husky will do the rest.

How to install:

  1. Use Node version 12.16.1 (or use NVM and run nvm use)
  2. Run npm install and then npm run commit to commit your changes