Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (34 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.21 KB

Contributing to chckit

Thanks for your interest in contributing!
chckit is an open-source website reviewer and it’s still in active development — contributions big or small are welcome.

Ways to contribute

  • Fix typos / improve docs
  • Report bugs or suggest features (open an Issue)
  • Pick an existing Issue and submit a Pull Request
  • Improve UI/UX, accessibility, or performance
  • Add tests

Getting started

  1. Fork the repo
  2. Clone your fork: 
    git clone https://github.com/<your-username>/chckit.git
cd chckit
  3. Create a new branch for your changes: 
    git checkout -b feat/your-change

Commit Messages

Use clear and descriptive commit messages. Examples:

  • docs: add contributing guide
  • fix: correct typo in README
  • feat: improve homepage UI

Pull Request Checklist

Before opening a Pull Request, please make sure that:

  • The change matches the goal of the Issue (or explains why it’s needed)
  • Documentation has been updated (if relevant)
  • No unrelated changes are included
  • The PR has a clear title and description

Code of Conduct

Please be respectful and constructive. Assume good intent and help keep the community welcoming for everyone.