Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.12 KB

Overview

Contributing to openMFP

We want to make contributing to this project as easy and transparent as possible.

Our development process

We use GitHub to track issues and feature requests, as well as accept pull requests.

Pull requests

You are welcome to contribute with your pull requests. These steps explain the contribution process:

  1. Fork the repository and create your branch from main.
  2. Add tests for your code.
  3. If you've changed APIs, update the documentation.
  4. Make sure the tests pass. Our github actions pipeline is running the unit and e2e tests for your PR and will indicate any issues.
  5. Sign the Developer Certificate of Origin (DCO).

Testing

NOTE: You should always add if you are adding code to our repository.

To let tests run locally, run go test ./... in the root directory of the repository.

Issues

We use GitHub issues to track bugs. Please ensure your description is clear and includes sufficient instructions to reproduce the issue.

License

By contributing to openMFP, you agree that your contributions will be licensed under its Apache-2.0 license.