First off, thanks for taking the time to contribute. You're amazing! 🎉 😘 ✨
If at any point you need any help, the best way to get in touch with someone is in
#mlops-stacks channel on the MLOps.community Slack.
The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
- Contributing Components and Stacks
- Reporting Bugs
- Suggesting Feature Requests or Enhancements
- Pull Requests
- Check Code Style
- Yes! Pull request
- Code of Conduct
Contributing Components and Stacks
See the tutorial.
Bugs are tracked as GitHub issues, tagged with a
bug label. Search before you create an issue. When you create an issue, please provide the following information by filling in the template.
- Core documentation or website issues should be reported to the combinator repository
- Component or stack issues should be reported to the respective repository, because these may not be owned by the core contributors
Suggesting Feature Requests or Enhancements
Enhancements or feature requests are tracked as GitHub issues, tagged with an
enhancement label. When you create an issue, please provide the following information by filling in the template.
- Enhancements to combinator in general (e.g. new stacks, new components, new ideas) should be reported to the combinator repository
- Enhancements to components or stacks should be reported to the respective repository, because these may not be owned by the core contributors
Check Code Style
make lint and make sure all the tests pass.
make test and verify all the tests pass.
Commit Message Format
<Type>: Short description (fix #1234) Longer description here if necessary BREAKING CHANGE: only contain breaking change
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- breaking: A breaking change
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
- revert: Reverting changes
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
- reference GitHub issues at the end. If the commit doesn’t completely fix the issue, then use
(refs #1234)instead of
- use the imperative, present tense: "change" not "changed" nor "changes".
- the motivation for the change and contrast this with previous behavior.
Yes! Pull request
Make your pull request, then describe your changes.
Follow other PR title format on below.
<Type>: Short Description (fix #111) <Type>: Short Description (fix #123, #111, #122) <Type>: Short Description (ref #111)
If it has related to issues, add links to the issues (like
#123) in the description.
Code of Conduct
See the CODE_OF_CONDUCT.md.