diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..b9c076bc78 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to whylogs + +We welcome contributions to [whylogs](https://github.com/whylabs/whylogs) by the community. + +## How to report a problem + +Feel free to add issues related to the project. + +Please search [issue tracker](https://github.com/whylabs/whylogs/issues) before +creating a new issue for a bug, an improvement request, or a fetaure request). + +If you feel that you can fix or implement it yourself, please read a few +paragraphs below to learn how to submit your changes. + +## Submitting changes + +- Open a new issue in the + [issue tracker](https://github.com/whylabs/whylogs/issues). +- Setup the [development environment](DEVELOPMENT.md) if you need to + run tests or whylogs with your changes +- Fork [whylogs](https://github.com/whylabs/whylogs.git) and prepare necessary + changes. +- Add tests for your changes to `tests/`. Changes + without tests are still going to be considered by us. +- Make sure all tests pass. +- Submit a pull request, referencing any issues it addresses. + +We will review your pull request as soon as possible. Thank you for +contributing! diff --git a/README.md b/README.md index a86ba48396..8e3a0cb94f 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,7 @@ whylogs is maintained by [WhyLabs](https://whylabs.ai). If you have any questions, comments, or just want to hang out with us, please join [our Slack channel](http://join.slack.whylabs.ai/). + ## Contribute -We welcome contributions to whylogs. Please see our [developement guide](https://github.com/whylabs/whylogs/blob/mainline/DEVELOPMENT.md) for details. +We welcome contributions to whylogs. Please see our [contribution guide](https://github.com/whylabs/whylogs/blob/mainline/CONTRIBUTING.md) and our [developement guide](https://github.com/whylabs/whylogs/blob/mainline/DEVELOPMENT.md) for details.