Skip to content

Commit 2b81b77

Browse files
author
Nabil Fayak
committed
updated documentation
1 parent 0fa0857 commit 2b81b77

File tree

3 files changed

+52
-53
lines changed

3 files changed

+52
-53
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Read more about CheckMates on our [documentation page](#):
3636

3737
The CheckMates community is happy to provide support to users of CheckMates. Project support can be found in four places depending on the type of question:
3838
1. For usage questions, use [Stack Overflow](#) with the `CheckMates` tag.
39-
2. For bugs, issues, or feature requests start a [Github issue](#).
39+
2. For bugs, issues, or feature requests start a [Github issue](https://github.com/alteryx/CheckMates/issues).
4040
3. For discussion regarding development on the core library, use [Slack](#).
4141
4. For everything else, the core developers can be reached by email at [email protected]
4242

docs/source/release_notes.rst

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
11
Release Notes
22
-------------
3-
.. **Future Releases**
4-
.. * Enhancements
5-
.. * Fixes
6-
.. * Changes
7-
.. * Documentation Changes
8-
.. * Testing Changes
3+
**Future Releases**
4+
* Enhancements
5+
* Fixes
6+
* Changes
7+
* Documentation Changes
8+
* Updated readme.md, contrubuting.md, and releases.md to reflect CheckMates package installation, quickstart, and useful links :pr:`13`
9+
* Testing Changes
910

1011
**v0.1.0 July 28, 2023**
11-
* Enhancements
12-
* updated pyproject to v0.1.0 for first release and added project urls :pr:`8`
13-
* added pdm.lock and .python-version to .gitignore :pr:`8`
14-
* Added repo specific token for workflows :pr:`2`
15-
* PDM Packaging ready for deployment :pr:`2`
16-
* Added testing workflow for pytest :pr:`2`
17-
* Transfer over base `Data Checks` and `IDColumnData Checks` from the `EvalML` repo :pr:`1`
18-
* Added in github workflows that are relevant to `DataChecks`, from `EvalML` repository, and modified to fit `DataChecks` wherever possible :pr:`1`
19-
* Implemented linters and have them successfully running :pr:`1`
20-
* Fixes
21-
* Cleanup files and add release workflow :pr:`6`
22-
* Fixed pytest failures :pr:`1`
23-
* Workflows are now up and running properly :pr:`1`
24-
* Changes
25-
* Irrelevant workflows removed (`minimum_dependency_checker`) :pr:`2`
26-
* Removed all `EvalML` dependencies and unnecessary functions/comments from `utils`, `tests`, `exceptions`, and `datachecks` :pr:`1`
27-
* Updated comments to reflect `DataChecks` repository :pr:`1`
28-
* Restructured file directory to categorize data checks between `datacheck_meta` and `checks` :pr:`1`
29-
* Restructured pdm packaging to only be relevant to `DataChecks`, now to be renamed to `CheckMate` :pr:`1`
30-
* Documentation Changes
31-
* Documentation refactored to now fit `CheckMates` :pr:`11`
32-
* Documentation refactored to now fit `Checkers` :pr:`4`
33-
* Documentation refactored to now fit `CheckMate` :pr:`2`
34-
* Testing Changes
35-
* Automated testing within github actions :pr:`2`
36-
* Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1`
12+
* Enhancements
13+
* updated pyproject to v0.1.0 for first release and added project urls :pr:`8`
14+
* added pdm.lock and .python-version to .gitignore :pr:`8`
15+
* Added repo specific token for workflows :pr:`2`
16+
* PDM Packaging ready for deployment :pr:`2`
17+
* Added testing workflow for pytest :pr:`2`
18+
* Transfer over base `Data Checks` and `IDColumnData Checks` from the `EvalML` repo :pr:`1`
19+
* Added in github workflows that are relevant to `DataChecks`, from `EvalML` repository, and modified to fit `DataChecks` wherever possible :pr:`1`
20+
* Implemented linters and have them successfully running :pr:`1`
21+
* Fixes
22+
* Cleanup files and add release workflow :pr:`6`
23+
* Fixed pytest failures :pr:`1`
24+
* Workflows are now up and running properly :pr:`1`
25+
* Changes
26+
* Irrelevant workflows removed (`minimum_dependency_checker`) :pr:`2`
27+
* Removed all `EvalML` dependencies and unnecessary functions/comments from `utils`, `tests`, `exceptions`, and `datachecks` :pr:`1`
28+
* Updated comments to reflect `DataChecks` repository :pr:`1`
29+
* Restructured file directory to categorize data checks between `datacheck_meta` and `checks` :pr:`1`
30+
* Restructured pdm packaging to only be relevant to `DataChecks`, now to be renamed to `CheckMate` :pr:`1`
31+
* Documentation Changes
32+
* Documentation refactored to now fit `CheckMates` :pr:`11`
33+
* Documentation refactored to now fit `Checkers` :pr:`4`
34+
* Documentation refactored to now fit `CheckMate` :pr:`2`
35+
* Testing Changes
36+
* Automated testing within github actions :pr:`2`
37+
* Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1`
3738

3839
**v0.0.2 July 26, 2023**
3940
* Enhancements
@@ -49,22 +50,20 @@ Release Notes
4950
* Automated testing within github actions :pr:`2`
5051

5152
**v0.0.1 July 18, 2023**
52-
53-
* Enhancements
54-
* Transfer over base `Data Checks` and `IDColumnData Checks` from the `EvalML` repo :pr:`1`
55-
* Added in github workflows that are relevant to `DataChecks`, from `EvalML` repository, and modified to fit `DataChecks` wherever possible :pr:`1`
56-
* Implemented linters and have them successfully running :pr:`1`
57-
* Fixes
58-
* Fixed pytest failures :pr:`1`
59-
* Workflows are now up and running properly :pr:`1`
60-
* Changes
61-
* Removed all `EvalML` dependencies and unnecessary functions/comments from `utils`, `tests`, `exceptions`, and `datachecks` :pr:`1`
62-
* Updated comments to reflect `DataChecks` repository :pr:`1`
63-
* Restructured file directory to categorize data checks between `datacheck_meta` and `checks` :pr:`1`
64-
* Restructured pdm packaging to only be relevant to `DataChecks`, now to be renamed to `CheckMate` :pr:`1`
65-
* Testing Changes
66-
* Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1`
53+
* Enhancements
54+
* Transfer over base `Data Checks` and `IDColumnData Checks` from the `EvalML` repo :pr:`1`
55+
* Added in github workflows that are relevant to `DataChecks`, from `EvalML` repository, and modified to fit `DataChecks` wherever possible :pr:`1`
56+
* Implemented linters and have them successfully running :pr:`1`
57+
* Fixes
58+
* Fixed pytest failures :pr:`1`
59+
* Workflows are now up and running properly :pr:`1`
60+
* Changes
61+
* Removed all `EvalML` dependencies and unnecessary functions/comments from `utils`, `tests`, `exceptions`, and `datachecks` :pr:`1`
62+
* Updated comments to reflect `DataChecks` repository :pr:`1`
63+
* Restructured file directory to categorize data checks between `datacheck_meta` and `checks` :pr:`1`
64+
* Restructured pdm packaging to only be relevant to `DataChecks`, now to be renamed to `CheckMate` :pr:`1`
65+
* Testing Changes
66+
* Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1`
6767

6868
**v0.0.0 July 3, 2023**
69-
70-
* *GitHub Repo Created*
69+
* *GitHub Repo Created*

release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
## 0. Pre-Release Checklist
44
Before starting the release process, verify the following:
55
* All work required for this release has been completed and the team is ready to release.
6-
* [All Github Actions tests are green on main](#).
6+
* [All Github Actions tests are green on main](https://github.com/alteryx/CheckMates/actions?query=branch%3Amain).
77
* The [ReadtheDocs build](#) for "latest" is marked as passed. To avoid mysterious errors, best practice is to empty your browser cache when reading new versions of the docs!
8-
* The [public documentation for the "latest" branch](#) looks correct, and the [release notes](#) includes the last change which was made on main.
8+
* The [public documentation for the "latest" branch](#) looks correct, and the [release notes](https://github.com/alteryx/CheckMates/blob/quickstart-installation_update/docs/source/release_notes.rst) includes the last change which was made on main.
99
* Get agreement on the version number to use for the release.
1010

1111
#### Version Numbering
1212

1313
CheckMates uses [semantic versioning](https://semver.org/). Every release has a major, minor and patch version number, and are displayed like so: `<majorVersion>.<minorVersion>.<patchVersion>`.
1414

15-
If you'd like to create a development release, which won't be deployed to pypi and conda and marked as a generally-available production release, please add a "dev" prefix to the patch version, i.e. `X.X.devX`. Note this claims the patch number--if the previous release was `0.12.0`, a subsequent dev release would be `0.12.dev1`, and the following release would be `0.12.2`, *not* `0.12.1`. Development releases deploy to [test.pypi.org](#) instead of to [pypi.org](#).
15+
If you'd like to create a development release, which won't be deployed to pypi and conda and marked as a generally-available production release, please add a "dev" prefix to the patch version, i.e. `X.X.devX`. Note this claims the patch number--if the previous release was `0.12.0`, a subsequent dev release would be `0.12.dev1`, and the following release would be `0.12.2`, *not* `0.12.1`. Development releases deploy to [test.pypi.org](https://test.pypi.org/project/checkmates/) instead of to [pypi.org](https://pypi.org/project/CheckMates/).
1616

1717
## 1. Freeze `main` and run perf tests
1818
After confirming the release is ready to go in step 0, we'll freeze the `main` branch and kick off the release performance tests.

0 commit comments

Comments
 (0)