|
| 1 | +# Contributing to content-md |
| 2 | + |
| 3 | +Thank you for your interest in contributing to content-md! This document explains how to contribute and where different types of feedback belong. |
| 4 | + |
| 5 | +## Types of Contributions |
| 6 | + |
| 7 | +### Documentation Improvements |
| 8 | + |
| 9 | +We welcome improvements to the [documentation site](https://contentmd.org) — typo fixes, clarity improvements, better examples, and new guides. Documentation lives in the `source/` directory as `.blade.php` files. |
| 10 | + |
| 11 | +### Bug Reports |
| 12 | + |
| 13 | +Found a bug in the spec or documentation? [Open an issue](https://github.com/OneOffTech/contentmd/issues). |
| 14 | + |
| 15 | +### Proposals, Questions, and Feedback |
| 16 | + |
| 17 | +Have a feature request, spec design question, or general feedback? [Start a discussion](https://github.com/OneOffTech/contentmd/discussions). We use Discussions for proposals and open-ended conversation, and reserve Issues for concrete bugs and problems. |
| 18 | + |
| 19 | +Proposals should address real implementation challenges you've encountered, not theoretical concerns. Show us the problem you faced and how your proposal addresses it. |
| 20 | + |
| 21 | +We maintain a high bar for additions to the spec — it is much easier to add things to a specification than to remove them. Every new feature adds complexity that all implementers must understand and support. When in doubt, leave it out. |
| 22 | + |
| 23 | +> [!NOTE] |
| 24 | +> **Not sure where to post?** Default to [Discussions](https://github.com/OneOffTech/contentmd/discussions). If it turns out to be a bug, we'll convert it to an issue. |
| 25 | +
|
| 26 | +### Ecosystem Listings |
| 27 | + |
| 28 | +If your product or platform has implemented content-md support, you can request to be listed on [contentmd.org](https://contentmd.org). Your implementation must be publicly available — we do not list products that have only announced intent to support content-md or are still in private beta. |
| 29 | + |
| 30 | +Submit a pull request with: |
| 31 | + |
| 32 | +1. **Logo files** — SVG preferred; PNG acceptable (min 200×200px). Provide light and dark variants. |
| 33 | +2. **An ecosystem entry** — Add your product to the ecosystem section in the docs. |
| 34 | +3. **Product information** — In your PR description, include your product name, a link to your product, and a link to documentation showing your content-md implementation. |
| 35 | + |
| 36 | +We may ask for a demo or screenshot to verify the implementation. |
| 37 | + |
| 38 | +### What We're Not Accepting (Yet) |
| 39 | + |
| 40 | +To keep the project focused during this early stage, we are currently not accepting: |
| 41 | + |
| 42 | +- **Major architectural changes** — We're still iterating on the core specification. Large-scale redesigns are premature. |
| 43 | + |
| 44 | +If you're unsure whether your contribution fits, open a [Discussion](https://github.com/OneOffTech/contentmd/discussions) before investing significant effort. |
| 45 | + |
| 46 | +## Development Setup |
| 47 | + |
| 48 | +### Documentation Site |
| 49 | + |
| 50 | +The documentation site is built with [Jigsaw](https://jigsaw.tighten.com/) and [Tailwind CSS](https://tailwindcss.com/). |
| 51 | + |
| 52 | +```bash |
| 53 | +# Install PHP dependencies |
| 54 | +composer install |
| 55 | + |
| 56 | +# Install JS dependencies |
| 57 | +npm ci |
| 58 | + |
| 59 | +# Run local dev server |
| 60 | +npm run dev |
| 61 | +``` |
| 62 | + |
| 63 | +In a separate terminal, serve the static site: |
| 64 | + |
| 65 | +```bash |
| 66 | +./vendor/bin/jigsaw serve |
| 67 | +``` |
| 68 | + |
| 69 | +Local preview will be available at `http://localhost:8000`. |
| 70 | + |
| 71 | +## Submitting Changes |
| 72 | + |
| 73 | +1. [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) |
| 74 | +2. Create a branch for your changes |
| 75 | +3. Make your changes and verify they work locally |
| 76 | +4. Submit a pull request |
| 77 | + |
| 78 | +Keep PRs focused on one logical change and link any related issues. |
| 79 | + |
| 80 | +## AI Contributions |
| 81 | + |
| 82 | +> [!IMPORTANT] |
| 83 | +> If you are using **any kind of AI assistance** to contribute to content-md, please disclose it in the pull request or issue. |
| 84 | +
|
| 85 | +We welcome the use of AI tools to help improve content-md. That said, if you used AI assistance (e.g., Claude Code, ChatGPT) while contributing, **disclose it in the pull request or issue**, along with the extent of AI involvement. |
| 86 | + |
| 87 | +As an exception, trivial spacing or typo fixes don't need to be disclosed. |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +By contributing, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE) for code, and [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) for documentation and specification files. |
0 commit comments