Contributing to CausalPipe
Thank you for considering contributing to CausalPipe! We welcome all kinds of contributions, including:
- Bug fixes
- New features or improvements
- Documentation improvements
How to Contribute
-
Fork the Repository: Click the "Fork" button at the top of the GitHub page to create a copy of the repository under your GitHub account.
-
Clone Your Fork: Clone the forked repository to your local machine.
bash git clone https://github.com/your-username/causal-pipe.git
-
Create a Branch: Create a new branch for your changes.
bash git checkout -b feature/new-feature
-
Make Your Changes: Implement your changes, whether it's code, tests, or documentation.
-
Commit Your Changes: Commit your changes with a meaningful commit message.
bash git commit -m "Added a new feature"
-
Push to GitHub: Push the changes to your GitHub fork.
bash git push origin feature/new-feature
-
Submit a Pull Request: Open a pull request on the original repository and describe the changes you’ve made.
Please ensure your code follows the project's coding standards and includes appropriate tests.
For any questions or suggestions, feel free to contact us at albert.buchard@gmail.com.