Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.04 KB
Raw

Contributing

The following is a set of guidelines for contributing to layered file protocols. Please note that maintainers team at the moment has very limited capacity to follow up on external contributions.

Some of the ways you can help:

  • Submitting bug reports: see Issues.
  • Fixing typos and generally improving the documentation.
  • Writing tutorials, examples, and how-to documents.

Commits

We strive to keep a consistent and clean git history and all contributions should adhere to the following:

  1. All tests should pass on all commits
  2. A commit should do one atomic change on the repository
  3. The commit headline should be descriptive and in the imperative

Pull request process

  1. Work on your own fork of the main repo.
  2. Push your commits and make a draft pull request.
  3. Check that your pull request passes all tests.
  4. When all tests have passed and your are happy with your changes, change your pull request to "ready for review", and ask for a code review.