Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

85 lines (56 loc) · 1.62 KB

Contributing to Mockchaos

Thank you for your interest in contributing to Mockchaos! We welcome contributions of all kinds.

How to Contribute

1. Fork the Repository

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/your-username/mockchaos.git
cd mockchaos

2. Create a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name

3. Make Your Changes

Make your code changes, add tests if needed, and update documentation.

4. Run Checks Locally

Before submitting, make sure your code passes all checks:

# Format your code
make format

# Run tests
make tests

# Run linter
make lint

5. Commit Your Changes

Commit your changes with a clear message:

git add .
git commit -m "feat: add your feature description"

6. Push and Create a Pull Request

  1. Push your branch to your fork:

    git push origin feature/your-feature-name

  2. Go to the Mockchaos repository on GitHub

  3. Click "New Pull Request"

  4. Select your branch and fill out the PR description

  5. Submit the pull request

7. Ensure CI Passes

Make sure all CI checks pass:

  • ✅ Linter must pass
  • ✅ Tests must pass

If CI fails, please fix the issues and push updates to your branch.

What Can You Contribute?

  • 🐛 Bug fixes
  • ✨ New features
  • 📝 Documentation improvements
  • 🧪 Test improvements
  • 💡 Examples and use cases

Questions?

If you have questions, feel free to open an issue or ask in your pull request.

Thank you for contributing! 🎉