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
Copy file name to clipboardExpand all lines: README.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -669,6 +669,15 @@ To generate a local copy of the documentation from a clone of this repository, j
669
669
670
670
The reStructuredText files that make up the documentation are stored in the [docs directory](https://github.com/Microsoft/EconML/tree/main/doc); module documentation is automatically generated by the Sphinx build process.
671
671
672
+
## Release process
673
+
674
+
We use GitHub Actions to build and publish the package and documentation. To create a new release, an admin should perform the following steps:
675
+
676
+
1. Update the version number in `econml/_version.py` and add a mention of the new version in the news section of this file and commit the changes.
677
+
2. Manually run the publish_package.yml workflow to build and publish the package to PyPI.
678
+
3. Manually run the publish_docs.yml workflow to build and publish the documentation.
679
+
4. Under https://github.com/py-why/EconML/releases, create a new release with a corresponding tag, and update the release notes.
680
+
672
681
# Blogs and Publications
673
682
674
683
* June 2019: [Treatment Effects with Instruments paper](https://arxiv.org/pdf/1905.10176.pdf)
@@ -699,17 +708,13 @@ BibTex:
699
708
700
709
# Contributing and Feedback
701
710
702
-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
703
-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
704
-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
711
+
This project welcomes contributions and suggestions. We use the [DCO bot](https://github.com/apps/dco) to enforce a [Developer Certificate of Origin](https://developercertificate.org/) which requires users to sign-off on their commits. This is a simple way to certify that you wrote or otherwise have the right to submit the code you are contributing to the project. Git provides a `-s` command line option to include this automatically when you commit via `git commit`.
705
712
706
713
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
707
714
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
708
715
provided by the bot. You will only need to do this once across all repos using our CLA.
709
716
710
-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
711
-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
0 commit comments