1
- # DoubleML - Contributing Guidelines <a href =" https://docs.doubleml.org " ><img src =" https://raw.githubusercontent.com/DoubleML/doubleml-for-py/master /doc/logo.png " align =" right " width = " 120 " /></a >
1
+ # DoubleML - Contributing Guidelines <a href =" https://docs.doubleml.org " ><img src =" https://raw.githubusercontent.com/DoubleML/doubleml-for-py/main /doc/logo.png " align =" right " width = " 120 " /></a >
2
2
3
3
DoubleML is a community effort.
4
4
Everyone is welcome to contribute.
5
5
All contributors should adhere to this contributing guidelines
6
- and our [ code of conduct] ( https://github.com/DoubleML/doubleml-for-py/blob/master /CODE_OF_CONDUCT.md ) .
6
+ and our [ code of conduct] ( https://github.com/DoubleML/doubleml-for-py/blob/main /CODE_OF_CONDUCT.md ) .
7
7
The contributing guidelines are particularly helpful to get started for your first contribution.
8
8
9
9
## Submit a Bug Report :bug :
@@ -76,7 +76,7 @@ $ git remote add upstream https://github.com/DoubleML/doubleml-for-py.git
76
76
This allows you to easily keep your repository in synch via
77
77
``` bash
78
78
$ git fetch upstream
79
- $ git merge upstream/master
79
+ $ git merge upstream/main
80
80
```
81
81
82
82
5 . Install the ** development dependencies** via
@@ -112,7 +112,7 @@ When opening the PR you will be guided with a checklist.
112
112
- [x] ** References** to related issues or PRs are added.
113
113
114
114
- [x] The code passes ** all (unit) tests** (see
115
- [ below] ( https://github.com/DoubleML/doubleml-for-py/blob/master /CONTRIBUTING.md#unit-test-and-test-coverage )
115
+ [ below] ( https://github.com/DoubleML/doubleml-for-py/blob/main /CONTRIBUTING.md#unit-test-and-test-coverage )
116
116
for details).
117
117
To check, please run
118
118
``` bash
@@ -125,7 +125,7 @@ $ pytest .
125
125
- [x] Check whether your changes adhere to the ** PEP8 standards** .
126
126
For the check you can use the following code
127
127
``` bash
128
- $ git diff upstream/master -u -- " *.py" | flake8 --diff --max-line-length=127
128
+ $ git diff upstream/main -u -- " *.py" | flake8 --diff --max-line-length=127
129
129
```
130
130
131
131
If your PR is still ** work in progress** , please consider marking it a ** draft PR**
@@ -160,7 +160,7 @@ new model class (e.g. regressions or classifications).
160
160
Furthermore, the ** score components for the Neyman orthogonal score function need to be implemented** .
161
161
All other functionality is automatically available via inheritance from the abstract base class.
162
162
A ** template for new model classes** is available
163
- [ here] ( https://github.com/DoubleML/doubleml-docs/blob/master /model_templates/double_ml_model_template.py ) .
163
+ [ here] ( https://github.com/DoubleML/doubleml-docs/blob/main /model_templates/double_ml_model_template.py ) .
164
164
165
165
## Contribute Documentation :books :
166
166
The ** documentation** of DoubleML is generated with ** sphinx** and hosted at
0 commit comments