# Contributing to dir_spec Thank you for your interest in contributing to dir_spec! 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: - **[Code of Conduct][coc]** -- how we treat each other - **[AI Use Policy][ai-policy]** -- expectations around AI-assisted contributions By submitting a contribution you acknowledge that you have read and agree to these policies and practices. ## Getting Oriented | Resource | What it covers | |-----------------------------|----------------------------------------------------------| | [Security Policy][security] | Reporting vulnerabilities responsibly | | [Code Style Guide][style] | Formatting rules and code organization conventions | | [Tasks][tasks] | Running builds, tests, formatting, and linting with mise | | [Testing][testing] | How to write and organize tests | | [Commits][commits] | Conventional commit format and scoping rules | ## Ways to Contribute - **Report a bug** -- [open an issue][new-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][security] instead of filing a public issue ## Questions? If something is unclear, open a discussion or issue -- we're happy to help. [ai-policy]: https://github.com/aaronmallen/dir_spec/blob/main/docs/policy/ai.md [coc]: https://github.com/aaronmallen/dir_spec/blob/main/docs/policy/code-of-conduct.md [commits]: https://github.com/aaronmallen/dir_spec/blob/main/docs/dev/commits.md [new-issue]: https://github.com/aaronmallen/dir_spec/issues/new [security]: https://github.com/aaronmallen/dir_spec/blob/main/docs/policy/security.md [style]: https://github.com/aaronmallen/dir_spec/blob/main/docs/dev/code-style.md [tasks]: https://github.com/aaronmallen/dir_spec/blob/main/docs/dev/tasks.md [testing]: https://github.com/aaronmallen/dir_spec/blob/main/docs/dev/testing.md