From 71c080945a261fcab768801de8b7b02ca3821776 Mon Sep 17 00:00:00 2001 From: Keith Battocchi Date: Fri, 17 Mar 2023 12:43:51 -0400 Subject: [PATCH] Update developer documentation Signed-off-by: Keith Battocchi --- README.md | 17 +++++++++++------ doc/spec/faq.rst | 22 +++++----------------- 2 files changed, 16 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 11841a91..e5780ba1 100644 --- a/README.md +++ b/README.md @@ -669,6 +669,15 @@ To generate a local copy of the documentation from a clone of this repository, j 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. +## Release process + +We use GitHub Actions to build and publish the package and documentation. To create a new release, an admin should perform the following steps: + +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. +2. Manually run the publish_package.yml workflow to build and publish the package to PyPI. +3. Manually run the publish_docs.yml workflow to build and publish the documentation. +4. Under https://github.com/py-why/EconML/releases, create a new release with a corresponding tag, and update the release notes. + # Blogs and Publications * June 2019: [Treatment Effects with Instruments paper](https://arxiv.org/pdf/1905.10176.pdf) @@ -699,17 +708,13 @@ BibTex: # Contributing and Feedback -This project welcomes contributions and suggestions. Most contributions require you to agree to a -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us -the rights to use your contribution. For details, visit https://cla.microsoft.com. +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`. When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +This project has adopted the [PyWhy Code of Conduct](https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md). # References diff --git a/doc/spec/faq.rst b/doc/spec/faq.rst index 7e8b7ab4..e6d63dff 100644 --- a/doc/spec/faq.rst +++ b/doc/spec/faq.rst @@ -56,22 +56,10 @@ which is a good diagnostic as to the quality of your model. How do I give feedback? ------------------------------------ -This project welcomes contributions and suggestions. Most contributions require you to agree to -a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, -grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. - - -When you submit a pull request, a CLA-bot will automatically determine whether you need to provide -a CLA and decorate the PR appropriately (e.g., label, comment). -Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. - - -This project has adopted the Microsoft Open Source Code of Conduct. -For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. - - - - - +This project welcomes contributions and suggestions. We use the `DCO bot `_ to enforce a +`Developer Certificate of Origin ` 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 :code:`-s` command line option to include this automatically when you commit via :code:`git commit`. +This project has adopted the `PyWhy Code of Conduct `_.