-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add PR template and Contribution guide (#220)
* fix PR template * add contribution page and add reference in README
- Loading branch information
Showing
4 changed files
with
44 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## Description | ||
|
||
<!-- Description of changes --> | ||
|
||
## General Checklist | ||
|
||
- [ ] Tests added for this feature/bug | ||
if it was a bug, test must cover it. | ||
- [ ] Conform by the style guides, by using formatter | ||
- [ ] Documentation updated | ||
- [ ] (optional) Please add a label to your PR (it really helps with the release notes) | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters