Skip to content

Commit 71c0809

Browse files
committed
Update developer documentation
Signed-off-by: Keith Battocchi <[email protected]>
1 parent 4c9f413 commit 71c0809

File tree

2 files changed

+16
-23
lines changed

2 files changed

+16
-23
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,15 @@ To generate a local copy of the documentation from a clone of this repository, j
669669

670670
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.
671671

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+
672681
# Blogs and Publications
673682

674683
* June 2019: [Treatment Effects with Instruments paper](https://arxiv.org/pdf/1905.10176.pdf)
@@ -699,17 +708,13 @@ BibTex:
699708

700709
# Contributing and Feedback
701710

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`.
705712

706713
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
707714
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
708715
provided by the bot. You will only need to do this once across all repos using our CLA.
709716

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
712-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
717+
This project has adopted the [PyWhy Code of Conduct](https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md).
713718

714719
# References
715720

doc/spec/faq.rst

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,22 +56,10 @@ which is a good diagnostic as to the quality of your model.
5656
How do I give feedback?
5757
------------------------------------
5858

59-
This project welcomes contributions and suggestions. Most contributions require you to agree to
60-
a Contributor License Agreement (CLA) declaring that you have the right to, and actually do,
61-
grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
62-
63-
64-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
65-
a CLA and decorate the PR appropriately (e.g., label, comment).
66-
Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
67-
68-
69-
This project has adopted the Microsoft Open Source Code of Conduct.
70-
For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
71-
72-
73-
74-
75-
59+
This project welcomes contributions and suggestions. We use the `DCO bot <https://github.com/apps/dco>`_ to enforce a
60+
`Developer Certificate of Origin <https://developercertificate.org/>` which requires users to sign-off on their commits.
61+
This is a simple way to certify that you wrote or otherwise have the right to submit the code you are contributing to
62+
the project. Git provides a :code:`-s` command line option to include this automatically when you commit via :code:`git commit`.
7663

7764

65+
This project has adopted the `PyWhy Code of Conduct <https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md>`_.

0 commit comments

Comments
 (0)