Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.71 KB
Raw

Contributing to Loggerhead

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the Software License

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

Conventional Commits

We follow the Conventional Commits specification for our commit messages:

  • fix: a commit of the type fix patches a bug in your codebase
  • feat: a commit of the type feat introduces a new feature to the codebase
  • Others: docs:, style:, refactor:, perf:, test:, and others.

Report bugs using Github's issues

We use GitHub issues to track bugs. Report a bug by opening a new issue; it's that easy!

License

By contributing, you agree that your contributions will be licensed under its LICENSE.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft