README.md

Contributing to Doing #

Thank you for your interest in contributing to Doing! Whether you're fixing a bug, adding a feature, improving documentation, or just asking questions — all contributions are welcome.

Before You Start #

Please read and agree to the following before contributing:

By submitting a contribution you acknowledge that you have read and agree to these policies and practices and that your contributions will be licensed under the MIT License.

Getting Oriented #

Resource What it covers
ADRs Architecture decisions and their rationale
Process Guide How we plan, review, and ship work
Security Policy Reporting vulnerabilities responsibly
Code Style Guide Formatting rules and code organization conventions
Tasks Running builds, tests, formatting, and linting with mise
Testing How to write and organize tests
Commits Conventional commit format and scoping rules

Ways to Contribute #

  • Report a bug — open an issue with steps to reproduce
  • Suggest a feature — start a discussion or issue describing the problem you'd like solved
  • Fix a bug or implement a feature — check the issue tracker for open items, or bring your own idea
  • Improve documentation — typos, missing context, better examples — it all helps
  • Write or improve tests — more coverage makes the project more reliable for everyone
  • Review pull requests — thoughtful review is just as valuable as writing code
  • Report a security vulnerability — follow the Security Policy instead of filing a public issue

Questions? #

If something is unclear, open a discussion or issue — we're happy to help.