Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 3.19 KB

File metadata and controls

82 lines (61 loc) · 3.19 KB

All Contributors

Contributors ✨

Thanks goes to these wonderful people (emoji key):

georgef
George Filippou

🖋
boiqm
Boi Mai Quach

💻 🖋

Contributing Guide

This project welcomes contributions, suggestions, and feedback. All submissions are accepted under the Project's License. By contributing, you confirm that you either own the rights to the content you submit or have the authority to license it under the same terms. All feedback, suggestions, and contributions are not confidential.

We follow the principles of the all-contributors specification to recognize contributions of all forms.

Ways to Contribute

There are several ways you can help improve the CDA framework:

  • Add example notebooks demonstrating how to run simulations, perform causal discovery, or estimate causal effects with CDA.
  • Improve the causal discovery or causal estimation modules, including adding new algorithms or extending current functionality.
  • Enhance integration by connecting CDA components with other causal inference or time-series libraries.
  • Extend the API to support new capabilities such as interpretability tools, counterfactual prediction, or additional evaluation metrics.
  • Improve documentation, including explanations, tutorials, and code comments.
  • Report issues or suggest improvements through the GitHub Issues page.

How to Contribute

If you would like to contribute, please follow the steps below.

1. Fork the repository and clone your fork

git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>

2. Create a new branch for your feature or fix

git checkout -b feature/<your-feature-name>

or

git checkout -b fix/<bug-description>

3. Make your changes, then stage and commit them

git add .
git commit -m "Describe your change here"

4. Push the branch to your fork

git push origin feature/<your-feature-name>

or

git push origin fix/<bug-description>

5. Submit a Pull Request

Go to your fork on GitHub and click “Compare & Pull Request” to submit your contribution.