Skip to main content

Contributing to Le Circographe

We're excited that you're interested in contributing to Le Circographe! This document will guide you through the process of contributing to our open-source project.

Code of Conduct​

Please read and follow our Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Getting Started​

Find an Issue​

  • Browse our GitHub Issues to find something to work on
  • Issues labeled good first issue are perfect for newcomers
  • Feel free to ask questions in the issue comments if something is unclear

Fork the Repository​

  1. Fork the repository on GitHub
  2. Clone your fork locally: git clone https://github.com/YOUR-USERNAME/core.git
  3. Add the original repository as upstream: git remote add upstream https://github.com/LeCircographe-asso/core.git

Create a Branch​

Create a branch for your work based on the main branch:

git switch -c feature/your-feature-name

Use a descriptive name that reflects the work you're doing.

Development Workflow​

  1. Make your changes in your feature branch
  2. Follow our coding standards and style (we use Rubocop)
  3. Add tests for your changes
  4. Make sure all tests pass before submitting your contribution
  5. Update documentation if necessary

Submitting a Pull Request​

  1. Push your changes to your fork: git push origin feature/your-feature-name
  2. Go to your repository on GitHub and click "New Pull Request"
  3. Select your branch and submit the pull request
  4. Fill out the PR template with all required information
  5. Wait for a maintainer to review your PR

Code Review Process​

  • A maintainer will review your code
  • You may need to make additional changes based on feedback
  • Once approved, a maintainer will merge your contribution

Documentation​

  • If you're adding a new feature, please include documentation
  • Update existing documentation if you're changing functionality

Testing​

  • Add tests for new features
  • Update tests for changed functionality
  • Make sure all tests pass before submitting a PR

Thank you for contributing to Le Circographe!