Skip to content
Zach Grace edited this page Mar 29, 2018 · 2 revisions

Contributing

Contributions are welcome and encouraged! But there's a few things you should know.

changeme makes heavy use of unit testing. The testing ensures that modifications to the codebase doesn't break expected behavior. All pull requests are run against the unit tests and only those that pass can be merged.

Adding New Credentials

New credentials must pass schema validation. If you created the credential file using ./changeme.py --mkcred, then your file should be valid. If you modified it by hand, you can run ./changeme.py --validate to validate it.

Adding New Code

If you're implementing new code, you must have corresponding unit tests that exercise the code. I'd recommend adding the script command from the .travis.yml file to your .git/hooks/pre-commit to help you out.

Versioning

The versioning is based on Semantic Versioning 2.0.0.

a.b.c

  • a - major: changes that break backwards compatibility
  • b - minor: addition of minor functionality
  • c - patch: bug fixes and adding credentials
Clone this wiki locally