asciidisco/cfp-magick

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue with the owners of this repository before making a change.

Please note we have a [code of conduct](code-of-conduct.md), please follow it in all your interactions with the project.

## Pull Request Process

1. Update the README.md with details of changes to the interface, this includes new environment
   variables, exposed ports, useful file locations and container parameters.
2. Use ```npm run cz``` to commit changes to adhere to our commit style guide
3. We run code style checking, commit message validation & tests via githooks on every commit & push
   please do not try to undermine those checks, otherwise your code can't be accepted
4. If you do introduce dependencies to the project, please make sure that they don't contain any vulnarabilities & are compliant with the projects license