You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Thanks for sending a pull request! Here are some tips for you:
2
+
3
+
1. Ensure that your code follows our code conventions: https://github.com/katonic-dev/explainit/blob/master/CONTRIBUTING.md#4-code-style--linting
4
+
2. Run unit tests and ensure that they are passing: https://github.com/katonic-dev/explainit/blob/master/CONTRIBUTING.md#5-running-unit-tests
5
+
3. If your change introduces any API changes, make sure to update the integration tests here: https://github.com/katonic-dev/explainit/blob/master/tests
6
+
4. Make sure documentation is updated for your PR!
7
+
5. Make sure your commits are signed: https://github.com/katonic-dev/explainit/blob/master/CONTRIBUTING.md#6-signing-off-commits
8
+
6. Make sure your PR title follows conventional commits (e.g. fix: [description] vs feat: [description])
9
+
10
+
-->
11
+
12
+
**What this PR does / why we need it**:
13
+
14
+
**Which issue(s) this PR fixes**:
15
+
<!--
16
+
*Automatically closes linked issue when PR is merged.
17
+
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
**Explainit 1.1 release introduces major features**
6
+
7
+
**Features**
8
+
9
+
-[Python] Introducing 5 major Independent Statistical Tests (Chi-Square, Jensen-Shannon, Kolmogorov-Smirnov, Wasserstein-Distance, Z-Score) to calculate & Detect Drifts in Data (for both Batch Data and Production Data).
10
+
-[Python] Added Histograms, Pie-charts & Scatter Graphs modules for Data Quality Management, Data Summary & Feature Summary calculation.
11
+
-[Python] Added Correlation Graphs modules to get the insights of the relationship between features.
12
+
-[Python] Removed support for 2 Statistial Tests (Population Stability Index (PSI), Kullback Leibler Divergence (KL Div)).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Here is the general workflow:
17
17
* Clone the repository
18
18
* Make the changes and commit them
19
19
* Push the branch to your local fork
20
-
* Make sure that all the tests are passing sucessfully
20
+
* Make sure that all the tests are passing successfully
21
21
* Submit a Pull Request with described changes
22
22
23
23
### Additional information
@@ -52,17 +52,23 @@ To use the cloned version in the virtual environment as an app, you need to inst
52
52
53
53
#### MacOS / Linux
54
54
```sh
55
-
cd /path/to/evidently_repo
55
+
cd /path/to/explainit_repo
56
56
pip install -e .[dev]
57
57
```
58
58
59
59
#### Windows
60
60
```sh
61
-
cd C:\path\to\evidently_repo
61
+
cd C:\path\to\explainit_repo
62
62
pip install -e .[dev]
63
63
```
64
64
65
-
## 4. Run the tests
65
+
## 4. Code-Style--linting
66
+
67
+
### Conforms to [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/index.html)
68
+
```sh
69
+
black explainit
70
+
```
71
+
66
72
### Running flake8
67
73
We use flake8 for code style checks.
68
74
```sh
@@ -76,8 +82,20 @@ We use mypy for object types checks.
76
82
mypy
77
83
```
78
84
79
-
###Running unit tests
85
+
##5. Running unit tests
80
86
Currently, the project is not fully covered by unit tests, but we are going to add more soon and expect to receive PRs with some unit tests 🙂
81
87
```sh
82
88
pytest -v
83
89
```
90
+
91
+
## 6. Signing off commits
92
+
> :warning: Warning: using the default integrations with IDEs like VSCode or IntelliJ will not sign commits. When you submit a PR, you'll have to re-sign commits to pass the DCO check.
93
+
94
+
Use git signoffs to sign your commits. See https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification for details.
95
+
96
+
Then, you can sign off commits with the `-s` flag:
@@ -116,7 +118,7 @@ Below is a snapshot of the landing page of Explainit Dashboard.
116
118
<br />
117
119
118
120
## Contributor Guide
119
-
Interested in contributing? Check out our [CONTRIBUTING.md](https://github.com/katonic-dev/explainit/blob/issue%237/CONTRIBUTION.md) to find resources around contributing along with a detailed guide on how to set up a development environment.
121
+
Interested in contributing? Check out our [CONTRIBUTING.md](CONTRIBUTION.md) to find resources around contributing along with a detailed guide on how to set up a development environment.
120
122
121
123
## QnA
122
124
@@ -135,4 +137,4 @@ Interested in contributing? Check out our [CONTRIBUTING.md](https://github.com/k
135
137
> * Make changes or train new models for production.
136
138
> * Update the domain specific concepts to understand the real-world better for new models.
137
139
138
-
- for more FAQs visit [faq.md](https://github.com/katonic-dev/explainit/blob/issue%237/docs/faq.md).
0 commit comments