Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (55 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.48 KB

Contributing to Free-Claude-Code-Guide

Thank you for your interest in contributing to this project! This guide will help you get started.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list to avoid duplicates. When creating a bug report, include as many details as possible :

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce
  • Provide specific examples
  • Describe the behavior observed
  • Include screenshots if applicable
  • Include your OS, Python, uv version

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues:

  • Use a clear and descriptive title
  • Provide a step-by-step description
  • Explain why this enhancement would be useful
  • List some other guides where this exists

Pull Request Process

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes (markdownlint README.md)
  4. Make sure your code follows the style guidelines
  5. Issue that pull request!

Style Guidelines

Markdown Style

  • Use GitHub Flavored Markdown
  • Limit lines to 120 characters where possible
  • Use fenced code blocks with language identifiers
  • Use tables for structured data
  • Use emojis sparingly and only when relevant

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Documentation

  • Write in French (primary language of this guide)
  • Be explicit and verbose when explaining technical concepts
  • Include examples for every configuration option
  • Explain "why" not just "how"

Review Process

The maintainers will review your pull request and may suggest changes. This is a normal part of the process. Once your PR is approved and passes CI checks, it will be merged.

Thank you for contributing!