Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 1.08 KB
Raw

Contributing to wayout

  1. Fork the repo and create your branch from main.
  2. Make sure to write tests for the functions you make.
  3. Run make check once you're done and ensure the test suite passes.

Any contributions you make will be under the BSD-2-Clause Software License

In short, when you submit code changes, your submissions are understood to be under the same BSD-2-Clause License that covers the project. Feel free to contact the maintainers if that's a concern.

Use a Consistent Coding Style

I'm again borrowing these from Facebook's Guidelines

  • 4 spaces for indentation.
  • You can run make check for style unification.

Proper Commit Messages

Make sure to write proper commit messages.

Example: [refactor] wayshot.rs, per output selection.

License

By contributing, you agree that your contributions will be licensed under its BSD-2-Clause License.

References

This document was adapted from GitHub Gist.