From 5afb600aa624d739e485e4d738cc5455c073c86a Mon Sep 17 00:00:00 2001 From: necatiozmen Date: Fri, 3 Apr 2026 12:35:27 +0300 Subject: [PATCH] update README --- CONTRIBUTING.md | 11 ++++++----- README.md | 2 ++ 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f700f07..684d8ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,11 +16,12 @@ We receive many requests, and maintainer bandwidth is limited. Sponsor-backed re If you notice issues with an existing file: -1. Open the site's `DESIGN.md` -2. Compare against the live site -3. Fix incorrect hex values, missing tokens, or weak descriptions -4. Update the `preview.html` and `preview-dark.html` if your changes affect displayed tokens -5. Open a PR with before/after rationale +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 diff --git a/README.md b/README.md index 3d1802b..99ee5e0 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. - **Improve existing files**: Fix wrong colors, missing tokens, weak descriptions - **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