Contributing to Metaflow
First off, thanks for taking the time!
If you are interested in contributing to Metaflow, we'd love to hear from you! Drop us a line in our chatroom.
Contributing Code and Issues
We are proud of our philosophy and human-centric development style, which means that we value thoughtfulness and a polished user experience more than the number of features or lines of code.
When Metaflow was developed internally at Netflix, we spent a considerable amount of time, often months, to hone the design for features before we implemented them. We are not sure what’s the best way to facilitate the design process in the open yet - your ideas are welcome. We have outlined our current suggested way below -
Please make sure there is an open issue discussing your contribution. Before opening a new issue, please check for existing issues. If you find an existing issue that matches closely with yours, please thumbs-up or comment on it, so we know that the issue is relevant to many people.
If you hit a bug that is not covered by an existing issue, please open a new issue. If you are able to fix the bug by yourself with a few lines of code, we welcome your PR. However, if fixing the bug requires more effort, please wait for our response on the issue. We try to respond as quickly as possible.
If you have a proposal for an enhancement or a new feature, please open an issue and engage with us on the issue before devoting significant time and resources to it. We care deeply about the ergonomics of Metaflow, and as such, for any new user-visible enhancement, please expect multiple design iterations.
We will do our best to respond to and review your PR and we hope you will stay engaged with us throughout the process.
We'd appreciate issue reports if you run into trouble using Metaflow.
Everyone is welcome to join us in our chatroom!
Please maintain appropriate, professional conduct while participating in our community. This includes all channels of communication. We take reports of harassment or unwelcoming behavior very seriously. To report such behavior, please contact us via email.