Contribution guidelines

Thank you for your interest in contributing to khefin!

Contributions are extremely welcome, including suggestions for adding portability and improving code quality.

A few basic guidelines:

• try to keep dependencies to a minimum; please file an issue before adding a new (runtime) dependency
• use hard tabs (tab stop = 4) for indentation, spaces for alignment (where necessary)
• please don't submit a pull request without an associated issue (it is totally fine to make an issue though!)

This is a checklist for getting your pull request merged:

• Issue number referenced in commit message(s)

• Changes squashed to a single commit, unless logically distinct (use Co-authored-by if necessary)

• No merge commits

• APPVERSION updated in metadata.make, in accordance with semantic versioning

• make format has been run to conform to code style

• make lint finishes with no non-suppressed warnings

• Checked that make, make release, make install and make clean all work as expected

• Checked that make clean; make compiles successfully with no warnings or errors

• CONTRIBUTORS.md and CHANGELOG.md are updated (if required)

• README.md is updated (if required)

• src/help.c, scripts/bash-completion.m4 and man pages are updated (if required)

• You accept that your contributions will be irrevocably released under the license specified in LICENSE