Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 2.02 KB

Contributing to Konfigyr Crypto library

Konfigyr Crypto library is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Using GitHub Issues

We use GitHub issues to track bugs and enhancements.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.

Ideally, that would include a complete & minimal sample project that reproduces the problem.

Submitting Pull Requests

This project uses pull requests for the community to suggest changes to the project.

There are a few important things to keep in mind when submitting a pull request:

  • Expect feedback and to make changes to your contributions.
  • Unless it is a minor change:
    • It is best to discuss pull requests on an issue before doing work
    • We expect the pull request to start with a draft pull request.
      • The pull request should be as small as possible and focus on a single unit of change.
      • We will discuss with you how to iterate once you have submitted the initial draft pull request.

Squash commits

Use git rebase –interactive, git add –patch and other tools to "squash" multiple commits into atomic changes.

Format commit messages

. Keep the subject line to 50 characters or fewer if possible. . Do not end the subject line with a period. . In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now. . Include Fixes gh- at the end if this fixes a GitHub issue.