laowang/awesome-design-md
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
necatiozmen
2026-04-03 12:35:27 +03:00
parent 5614efab97
commit 5afb600aa6
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -16,11 +16,12 @@ We receive many requests, and maintainer bandwidth is limited. Sponsor-backed re
If you notice issues with an existing file: If you notice issues with an existing file:
1. Open the site's `DESIGN.md` 1. **Open an issue first** to describe what you'd like to change and get feedback from maintainers
2. Compare against the live site 2. Open the site's `DESIGN.md`
3. Fix incorrect hex values, missing tokens, or weak descriptions 3. Compare against the live site
4. Update the `preview.html` and `preview-dark.html` if your changes affect displayed tokens 4. Fix incorrect hex values, missing tokens, or weak descriptions
5. Open a PR with before/after rationale 5. Update the `preview.html` and `preview-dark.html` if your changes affect displayed tokens
6. Open a PR with before/after rationale
## License ## License

2
README.md
View File

@@ -162,6 +162,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
- **Improve existing files**: Fix wrong colors, missing tokens, weak descriptions - **Improve existing files**: Fix wrong colors, missing tokens, weak descriptions
- **Report issues**: Let us know if something looks off - **Report issues**: Let us know if something looks off
Before opening a PR, please [open an issue](https://github.com/VoltAgent/awesome-design-md/issues) first to discuss your idea and get feedback from maintainers.
## License ## License