Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (38 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 1.86 KB
Raw

Contributing to CeloHT

Thanks for thinking about contributing. This repository is the governance and documentation hub for the whole CeloHT ecosystem, so the quality bar for changes here matters - it's often the first thing a new contributor, partner, or funder reads.

Code of Conduct

Everyone participating in this project is expected to follow our CODE_OF_CONDUCT.md.

What We're Looking For

  • Documentation improvements - clarity, translations, fixing errors
  • New examples in examples/
  • Improvements to the scripts in scripts/ and tools/
  • Improvements to GitHub Actions workflows
  • Governance proposals, raised as a Discussion rather than a direct Pull Request

How to Contribute

  1. Fork the repository and create a branch with a descriptive name (for example: docs/improve-developer-guide).
  2. Make your changes, keeping docs/repository-guide.md in mind.
  3. Test locally: run scripts/validate.sh to check Markdown, YAML, and links.
  4. Open a Pull Request using our PR template.
  5. Respond to review - a maintainer will look at it and may ask for changes.
  6. Once approved, a maintainer will merge it.

Quality Bar

  • Write clearly, in plain English, without unnecessary jargon.
  • No placeholder text, "coming soon" sections, or broken links.
  • Every document should have a clear purpose and stay consistent with the rest of the docs.
  • Follow the Markdown style rules in .markdownlint.yaml.

Commit Style

We follow Conventional Commits:

docs: add a section on the governance model
fix: correct broken link in docs/faq.md
feat(scripts): add a link validation script

Questions?

Ask in GitHub Discussions or check SUPPORT.md.