Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.19 KB

Contributing to Seldon Core

Before opening a pull request consider:

  • Is the change important and ready enough to ask the community to spend time reviewing?
  • Have you searched for existing, related issues and pull requests?
  • Is the change being proposed clearly explained and motivated?

When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's license and warrant that you have the legal authority to do so.

PRs

Automated checks are run against PRs to ensure a certain level of quality.

One of these is a check that PR titles conform to the Conventional Commit format. This format ensures certain small but useful pieces of context are available. Specifically, these are the type of change being introduced, whether or not it is a breaking change, and an optional scope of impact. The permitted types can be found in the CI workflow.