Contribute to our Website and Example Gallery
Find informations and hints that might help you in case you are interested in contributing to our website and Example Gallery.
To get in touch with us, please open a new issue in our GitHub repository of the online documentation https://github.com/DoubleML/doubleml-docs. Please tell us in the issue what you plan to contribute: What do you want to change in the documentation (e.g., fix a typo in the User Guide or add a new chapter?) or what kind of example do you want to add to the Example Gallery.
Step-by-Step Guide: Add an Example to the DoubleML Example Gallery
We are continuously extending our Example Gallery and encourage contributors to add reproducible notebooks in either R or Python or both languages.
Main steps for adding an example to the gallery
- Clone or fork the GitHub repository https://github.com/DoubleML/doubleml-docs and open your own branch. The name of the branch should start with a short acronym and be meaningful.
- Example: "Sarah" who wants to add an example on how to use DoubleML for estimation a causal effect in a randomized controlled trail and hence open a branch "S-RCT".
- The notebook example itself is a Jupyter Notebook (with a Python or R Kernel) that you add to the directory
doubleml-docs/doc/examples/. - The title of the notebook should start with the language you use.
- "R: Evaluation of a randomized controlled trial"
- Helpful resources: A helpful resource to structure your case study might be the DoubleML, the already existing examples in the gallery and the user guide.
- Add the notebook to
doubleml-docs/doc/examples/index.rstin order to have it listed in the Sandbox section of our gallery. - Once you are done with all chaneges, open a pull request and tag us for review. Once we have reviewed the example, we will add it to the main sections (R, Python or both).
In case you have any questions while working on the examples, just contact us, e.g., by tagging @MalteKurz or @PhilippBach in the GitHub issue.
Contributors to DoubleML are required to comply to our Code of Conduct.
We thank all contributors for their efforts and for their compliance with our Code of Conduct.