29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# Contributing to Awesome Design MD
|
|
|
|
Thanks for contributing.
|
|
|
|
This repository is a curated collection of DESIGN.md files extracted from popular websites. Each file captures a site's complete visual language in a format any AI agent can read.
|
|
|
|
## How to Contribute
|
|
|
|
### Request a New Site
|
|
|
|
To request a DESIGN.md for a website, [open an issue](https://github.com/VoltAgent/awesome-design-md/issues/new?template=design-md-request.yml) with the website URL.
|
|
|
|
We receive many requests, and maintainer bandwidth is limited. Sponsor-backed requests are prioritized, consider supporting the project via [GitHub Sponsors](https://github.com/sponsors/VoltAgent) if you'd like faster turnaround.
|
|
|
|
### Improve an Existing DESIGN.md
|
|
|
|
If you notice issues with an existing file:
|
|
|
|
1. **Open an issue first** to describe what you'd like to change and get feedback from maintainers
|
|
2. Open the site's `DESIGN.md`
|
|
3. Compare against the live site
|
|
4. Fix incorrect hex values, missing tokens, or weak descriptions
|
|
5. Update the `preview.html` and `preview-dark.html` if your changes affect displayed tokens
|
|
6. Open a PR with before/after rationale
|
|
|
|
## License
|
|
|
|
By contributing, you agree your contributions are provided under the repository license terms.
|