Skip to contents

Contributing

Thank you for your interest in contributing to CARD ! Whether you’re fixing bugs, improving documentation, or developing new features, we appreciate your involvement.

🚀 Getting Started

If you’re unsure where to begin: - Check out our open issues. - Feel free to open a new issue to ask questions or suggest ideas.

Want to Work on Something?

If you plan to tackle an issue or develop something new : - Open or comment on an issue to let us know you’re working on it. This helps avoid duplication and promotes collaboration !

🔧 How to Contribute

Here’s a step-by-step guide to contributing :

1. Fork the Repository

Click the Fork button at the top right of the CARD GitHub page to create a copy of the repo under your GitHub account.

2. Clone Your Fork

Clone your fork to your local machine:

git clone git@github.com:your-username/CARD.git
cd CARD

3. Create a New Branch

It’s best to work in a dedicated branch for each feature or fix :

git checkout -b your-feature-name

4. Make Your Changes

Edit the code, documentation, or tests. Be sure your changes : - Follow the project’s code style - Don’t break existing functionality - Include comments or documentation if needed

5. Commit and Push

After testing your changes locally :

git add path/to/your-new-file.txt
git commit -m "Clear description of what you did"
git push origin your-feature-name

6. Open a Pull Request

  • Go to your fork on GitHub and click “Compare & Pull Request.”
  • Fill out the PR template with:
    • A description of what you changed and why
    • Link to the issue you’re addressing (if applicable)
  • Submit the PR and wait for review

7. Address Feedback

Your PR may receive comments. Please respond, make updates, and re-push your branch.

🔄 Keeping Your Fork Up to Date

To sync your fork with the main repo:

Option 1: Using GitHub’s Web Interface

  • Navigate to your fork
  • Click “Sync fork” (in the top bar)

Option 2: Using Git (advanced)

git remote add upstream https://github.com/louis-heraut/CARD.git
git fetch upstream
git merge upstream/main
git push origin main

🤝 Work Collaboration

If we’re connected through work or you’d like to collaborate more deeply : - Reach out via email to discuss becoming a project collaborator.

📌 Notes

  • All changes must be reviewed before merging.
  • We use CODEOWNERS to manage pull request approvals.
  • Protected branches may require reviews or checks to pass before merging.

Thank you for contributing to CARD ! 🧪✨