Skip to content

Latest commit

 

History

History
127 lines (99 loc) · 5.27 KB

CONTRIBUTING.md

File metadata and controls

127 lines (99 loc) · 5.27 KB
Raw

🧑‍💻 Contributing to ZenML Projects

A big welcome and thank you for considering contributing to ZenML Projects! It’s people like you that make it a reality for users in our community.

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the developers' time management and develop these open-source projects. In return, we will reciprocate that respect by reading your issue(s), assessing changes, and helping you finalize your pull requests.

⚡️ Quicklinks

🧑‍⚖️ Code of Conduct

We take our open-source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

🛫 Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • To report security vulnerabilities, please get in touch at support@zenml.io, monitored by our security team.
  • Search for existing Issues and PRs before creating your own.
  • We work hard to make sure issues are handled on time, but it could take a while to investigate the root cause depending on the impact.

A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

The best way to start is to check the good-first-issue label on the issue board. The core team creates these issues as necessary smaller tasks that you can work on to get deeper into ZenML dashboard internals. These should generally require relatively simple changes, probably affecting just one or two files which we think are ideal for people new to ZenML dashboard.

The next step after that would be to look at the good-second-issue label on the issue board. These are a bit more complex, might involve more files, but should still be well-defined and achievable to people relatively new to ZenML dashboard.

⁉️ Issues

Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses your problem, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help by indicating to our maintainers that a particular issue is affecting more than just the reporter.

🏷 Pull Requests

Pull Requests (PRs) to ZenML Projects are always welcome. In general, PRs should:

  • Only fix/add the functionality in question OR address widespread whitespace/style issues, not both.
  • Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
  • Address a single concern in the least number of changed lines as possible.
  • Include documentation in the repo or in your Pull Request.
  • Be accompanied by a filled-out Pull Request template (loaded automatically when a PR is created).

For changes that address core functionality or would require breaking changes, it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, we follow the "fork-and-pull" Git workflow

  1. Review and sign the Contributor License Agreement ( CLA).
  2. Fork the repository to your own GitHub account.
  3. Clone the project to your machine.
  4. Checkout the main branch <- git checkout main.
  5. Create a branch locally off the main branch with a succinct but descriptive name.
  6. Commit changes to the branch.
  7. Push changes to your fork.
  8. Open a PR in our repository to the main branch and follow the PR template so that we can efficiently review the changes.

🚨 Reporting a Vulnerability

If you think you have found a vulnerability, and even if you are not sure about it, please report it right away by sending an email to: support@zenml.com. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue.

We will review it thoroughly and get back to you.

Please refrain from publicly discussing a potential security vulnerability as this could potentially put our users at risk! It's better to discuss privately and give us a chance to find a solution first, to limit the potential impact as much as possible.

🆘 Getting Help

Join us in the ZenML Slack Community to interact directly with the core team and community at large. This is a good place to ideate, discuss concepts or ask for help.