Contributing

Ways to participate and good practices when collaborating across Coderic repositories.

Thank you for your interest in contributing. This guide summarizes how to take part in Coderic projects in a useful and respectful way.

All interactions must follow our code of conduct.

Ways to contribute

Reporting issues

  1. Check for an existing issue.
  2. If none exists, open one in the correct repository.
  3. Include steps to reproduce, expected vs. actual behavior, and environment details.

Documentation

  • Fix typos and clarify explanations.
  • Add examples and use cases.
  • Translate or fill documentation gaps.

Code

  1. Fork the repository.
  2. Create a branch (git checkout -b feature/short-description).
  3. Use clear commit messages.
  4. Push and open a Pull Request targeting the branch the project uses (usually main).

Design, events, and more

UI work, branding, meetups, talks, and community operations are also contributions.

Standards

  • Code of conduct: code of conduct.
  • Quality: respect linting, tests, and repository conventions.
  • Documentation: document new public APIs or behavior.
  • Review: respond to maintainer feedback.

Pull requests

  1. Explain what changed and why.
  2. Make sure tests pass.
  3. Update docs when needed.
  4. Keep PRs focused; split large changes when possible.

Branching (general guidance)

  • Main integration branch (e.g. main) should stay usable per repo policy.
  • Use feature/*, fix/*, or the convention documented in each project.

Small vs. large changes

  • Small fixes are often reviewed quickly.
  • Large changes: start with an issue to align with maintainers.

Communication

  • Issues: bugs and concrete work in the repo.
  • Discussions (when enabled): broader questions.
  • E-mail [email protected] for topics that do not fit GitHub.

FAQ

Do I need to be an expert? No. Reporting bugs and improving docs already helps.

Where do I start? Look for good first issue labels or ask in the project discussion space.

What if my PR is declined? Feedback is meant to improve the change; iterate calmly.

Can I contribute without code? Yes: documentation, design, translation, events, and more.

Contact