Skip to content

Commit ad87aef

Browse files
committed
Add MVG projects docs
As explained in https://github.com/github/MVG. This adds a MAINTAINERS and a GOVERNANCE file. Signed-off-by: Peter Goetz <pego@amazon.com>
1 parent bb446c3 commit ad87aef

File tree

3 files changed

+70
-5
lines changed

3 files changed

+70
-5
lines changed

CONTRIBUTING.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,28 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
4747

4848
## Contributing Guide
4949

50-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
50+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Project's license](./LICENSE.md). You represent that if you do not own copyright in the code that you have the authority to submit it under the [Project's license](./LICENSE.md). All feedback, suggestions, or contributions are not confidential.
5151

52-
There are multiple ways to contribute to DoWhy.
52+
There are multiple ways to contribute to DoWhy.
5353

54-
You can help us make DoWhy better,
54+
You can help us make DoWhy better,
5555
* Adding a Jupyter notebook that describes the use of DoWhy for solving causal
5656
problems
5757

5858
* Helping implement a new method for any of the four steps of causal analysis:
5959
model, identify, estimate, refute
6060

6161
* Integrating DoWhy's API with external implementations for any of the four steps, so that external libraries can be called seamlessly from the `identify_effect`, `estimate_effect` or `refute_estimate` methods.
62-
63-
* Helping extend the DoWhy API so that we can support new functionality like interpretability of the estimate, counterfactual prediction and more.
62+
63+
* Helping extend the DoWhy API so that we can support new functionality like interpretability of the estimate, counterfactual prediction and more.
6464

6565
* Helping update the documentation for DoWhy
6666

6767
If you would like to contribute, you can raise a pull request. If you have
6868
questions before contributing, you can start by opening an issue on Github.
69+
70+
The Project abides by PyWhy's [code of conduct](https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md) and [trademark policy](https://github.com/py-why/governance/blob/main/TRADEMARKS.md).
71+
72+
---
73+
Part of MVG-0.1-beta.
74+
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

GOVERNANCE.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Governance Policy
2+
3+
This document provides the governance policy for the Project. Maintainers agree to this policy and to abide by all Project polices, including the [code of conduct](https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md), [trademark policy](https://github.com/py-why/governance/blob/main/TRADEMARKS.md), and [antitrust policy](https://github.com/py-why/governance/blob/main/ANTITRUST.md) by adding their name to the [MAINTAINERS.md file](./MAINTAINERS.md).
4+
5+
## 1. Roles.
6+
7+
This project may include the following roles. Additional roles may be adopted and documented by the Project.
8+
9+
**1.1. Maintainers**. Maintainers are responsible for organizing activities around developing, maintaining, and updating the Project. Maintainers are also responsible for determining consensus. This Project may add or remove Maintainers with the approval of the current Maintainers.
10+
11+
**1.2. Contributors**. Contributors are those that have made contributions to the Project.
12+
13+
## 2. Decisions.
14+
15+
**2.1. Consensus-Based Decision Making**. Projects make decisions through consensus of the Maintainers. While explicit agreement of all Maintainers is preferred, it is not required for consensus. Rather, the Maintainers will determine consensus based on their good faith consideration of a number of factors, including the dominant view of the Contributors and nature of support and objections. The Maintainers will document evidence of consensus in accordance with these requirements.
16+
17+
**2.2. Appeal Process**. Decisions may be appealed by opening an issue and that appeal will be considered by the Maintainers in good faith, who will respond in writing within a reasonable time. If the Maintainers deny the appeal, the appeal may be brought before the PyWhy Steering Committee, who will also respond in writing in a reasonable time.
18+
19+
## 3. How We Work.
20+
21+
**3.1. Openness**. Participation is open to anyone who is directly and materially affected by the activity in question. There shall be no undue financial barriers to participation.
22+
23+
**3.2. Balance**. The development process should balance the interests of Contributors and other stakeholders. Contributors from diverse interest categories shall be sought with the objective of achieving balance.
24+
25+
**3.3. Coordination and Harmonization**. Good faith efforts shall be made to resolve potential conflicts or incompatibility between releases in this Project.
26+
27+
**3.4. Consideration of Views and Objections**. Prompt consideration shall be given to the written views and objections of all Contributors.
28+
29+
**3.5. Written procedures**. This governance document and other materials documenting this project's development process shall be available to any interested person.
30+
31+
## 4. No Confidentiality.
32+
33+
Information disclosed in connection with any Project activity, including but not limited to meetings, contributions, and submissions, is not confidential, regardless of any markings or statements to the contrary.
34+
35+
## 5. Trademarks.
36+
37+
Any names, trademarks, logos, or goodwill developed by and associated with the Project (the "Marks") are controlled by the PyWhy. Maintainers may only use these Marks in accordance with the PyWhy's trademark policy. If a Maintainer resigns or is removed, any rights the Maintainer may have in the Marks revert to the PyWhy.
38+
39+
## 6. Amendments.
40+
41+
Amendments to this governance policy may be made by affirmative vote of 2/3 of all Maintainers, with approval by the PyWhy's Steering Committee.
42+
43+
---
44+
Part of MVG-0.1-beta.
45+
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

MAINTAINERS.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Maintainers
2+
3+
This document lists the Maintainers of the Project. Maintainers may be added once approved by the existing maintainers as described in the [Governance document](./GOVERNANCE.md). By adding your name to this list you are agreeing to abide by the Project governance documents and to abide by all of the PyWhy's polices, including the [code of conduct](https://github.com/py-why/governance/blob/main/CODE-OF-CONDUCT.md), [trademark policy](https://github.com/py-why/governance/blob/main/TRADEMARKS.md), and [antitrust policy](https://github.com/py-why/governance/blob/main/ANTITRUST.md). If you are participating because of your affiliation with another organization (designated below), you represent that you have the authority to bind that organization to these policies.
4+
5+
| **NAME** | **Organization** |
6+
| --- | --- |
7+
| Emre Kıcıman | Microsoft |
8+
| Amit Sharma | Microsoft |
9+
| Peter Götz | Amazon Web Services |
10+
| Patrick Blöbaum | Amazon Web Services |
11+
12+
---
13+
Part of MVG-0.1-beta.
14+
Made with love by GitHub. Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

0 commit comments

Comments
 (0)