Skip to content

Commit

Permalink
Added a few things to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Feb 12, 2020
1 parent 3fdd601 commit 52d6282
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,13 @@ Release
As a JustCause maintainer following steps are needed to release a new version:

#. Make sure all unit tests on `Cirrus-CI`_ are green.
#. Update the ``CHANGELOG.rst`` file.
#. Tag the current commit on the master branch with a release tag, e.g. ``v1.2.3``.
#. Clean up the ``dist`` and ``build`` folders with ``rm -rf dist build``
to avoid confusion with old builds and Sphinx docs.
#. Run ``python setup.py dists`` and check that the files in ``dist`` have
the correct version (no ``.dirty`` or Git hash) according to the Git tag.
Also sizes of the distributions should be less than 500KB, otherwise unwanted
Also sizes of the distributions should be less than 500KB (for bdist), otherwise unwanted
clutter may have been included.
#. Run ``twine upload dist/*`` and check that everything was uploaded to `PyPI`_ correctly.

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Optional and needed only once after `git clone`:
3. [EconML]: Heterogeneous Effect Estimation in Python
4. [awesome-list]: A very extensive list of causal methods and respective code
5. [IBM-Causal-Inference-Benchmarking-Framework]: Causal Inference Benchmarking Framework by IBM
6. [CausalNex]: Bayesian Networks to combine machine learning and domain expertise for causal reasoning.

## Note

Expand All @@ -88,3 +89,4 @@ For details and usage information on PyScaffold see https://pyscaffold.org/.
[EconML]: https://github.com/microsoft/EconML
[awesome-list]: https://github.com/rguo12/awesome-causality-algorithms
[IBM-Causal-Inference-Benchmarking-Framework]: https://github.com/IBM-HRL-MLHLS/IBM-Causal-Inference-Benchmarking-Framework
[CausalNex]: https://causalnex.readthedocs.io/

0 comments on commit 52d6282

Please sign in to comment.