docs: improve CONTRIBUTING with comprehensive descriptions and better readability (#921)

Author: FajarKim

CONTRIBUTING.md

@@ -1,74 +1,80 @@
-# Contributing to [github-readme-profile](https://github.com/FajarKim/github-readme-profile)
+# Contributing to GitHub Readme Profile
 
 We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
--   Reporting [an issue](https://github.com/FajarKim/github-readme-profile/issues/new?assignees=&labels=bug&template=bug_report.yml).
--   [Discussing](https://github.com/FajarKim/github-readme-profile/discussions) the current state of the code.
--   Submitting [a fix](https://github.com/FajarKim/github-readme-profile/compare).
--   Proposing [new features](https://github.com/FajarKim/github-readme-profile/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
--   Becoming a maintainer.
+- Reporting [an issue](https://github.com/FajarKim/github-readme-profile/issues/new?assignees=&labels=bug&template=bug_report.yml).
+- [Discussing](https://github.com/FajarKim/github-readme-profile/discussions) the current state of the code.
+- Submitting [a fix](https://github.com/FajarKim/github-readme-profile/compare).
+- Proposing [new features](https://github.com/FajarKim/github-readme-profile/issues/new?assignees=&labels=enhancement&template=feature_request.yml).
+- Becoming a maintainer.
 
-## 🌝 All Changes Happen Through Pull Requests
+## All Changes Happen Through Pull Requests
 
 Pull requests are the best way to propose changes. We actively welcome your pull requests:
 
-1.  Fork the repo and create your branch from `master`.
-2.  If you've added code that should be tested, add some tests' examples.
-3.  If you've changed APIs, update the documentation.
-4.  Issue that pull request!
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add test examples.
+3. If you've changed APIs, update the documentation.
+4. Issue that pull request!
 
-## 🎨 Themes Contribution
+## Theme Contribution
 
-GitHub Readme Profile supports custom theming, and you can also contribute new themes!
+GitHub Readme Profile supports custom theming, and you can contribute new themes to the built‑in collection.
 
-> [!NOTE]\
-> If you are contributing your theme just because you are using it personally, then you can [customize the looks](./README.md#customization) of your card with URL params instead.
+> [!NOTE]
+> If you are contributing a theme only for personal use, you can [customize the appearance](/README.md#customization) of your card with URL parameters instead, no pull request needed.
 
-> [!NOTE]\
-> Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up 👍 emojis. We expect to see at least 5-10 thumbs up before making a decision to merge your pull request into the master branch. Remember that you can also support themes of other contributors that you liked to speed up their merge.
+> [!NOTE]
+> Your pull request with a new theme will be merged once it receives enough positive feedback from the community (at least 5–10 👍 reactions). This helps ensure that only themes with broad appeal are included. You can also support themes from other contributors by upvoting them.
 
-> [!NOTE]\
-> Before submitting pull request, please make sure that your theme pass WCAG 2.0 level AA contrast ration test. You can use [this tool](https://webaim.org/resources/contrastchecker/) to check it.
+> [!NOTE]
+> Before submitting your theme, please ensure it passes the **WCAG 2.0 Level AA** contrast ratio test. You can use [WebAIM’s contrast checker](https://webaim.org/resources/contrastchecker/) to verify.
 
-To contribute your theme you need to edit the [themes/index.ts](/themes/index.ts) file and add it at the end of the file.
+To contribute a theme, edit the [`themes/index.ts`](/themes/index.ts) file and add your theme at the end of the file. Follow the existing structure: provide a descriptive name and a set of color definitions (`title_color`, `text_color`, `icon_color`, `border_color`, `bg_color`, etc.).
 
-## 🗣️ Translations Contribution
-GitHub Readme Profile supports multiple languages, if we are missing your language, you can contribute it! You can check the currently supported languages [here](/README.md#available-locales).
+## Translations Contribution
 
-To contribute your language you need to edit the [i18n/index.ts](/i18n/index.ts) file and add new property to each object where the key is the language code in ISO 639-1 standard and the value is the translated string. Anything appearing in [the list](https://gist.github.com/FajarKim/91516c2aecbfc8bf65f584d528d5f2b1) should be fine.
+GitHub Readme Profile supports multiple languages. If your language is missing, you can contribute a translation! See the currently supported languages in [`i18n/README.md`](/i18n/README.md).
 
-## 📑 Any contributions you make will be under the MIT Software License
+To add a new language:
 
-In short, when you submit changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+1. Edit the [`i18n/index.ts`](/i18n/index.ts) file.
+2. Add a new property to each translation object using the language code as the key. The code should follow the ISO 639-1 standard (e.g., `id`, `fr`, `ja`). Country‑specific codes like `pt-BR` are also acceptable.
+3. Provide the translated strings for all keys. You can use the existing translations as a reference.
 
-## ⚠️ Report issues/bugs using GitHub's [issues](https://github.com/FajarKim/github-readme-profile/issues)
+If you are unsure about the language code, check [this list](https://gist.github.com/FajarKim/91516c2aecbfc8bf65f584d528d5f2b1) for accepted codes.
 
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/FajarKim/github-readme-profile/issues/new/choose); it's that easy!
+## Any Contributions You Make Will Be Under the MIT Software License
+
+When you submit changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. If that's a concern, please contact the maintainers.
 
-### 🚨 Bug Reports
+## Report Issues or Bugs Using GitHub Issues
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/FajarKim/github-readme-profile/issues/new/choose); it's that easy!
 
-**Great Bug Reports** tend to have:
+### Bug Reports
 
--   A quick summary and/or background
--   Steps to reproduce
-    -   Be specific!
-    -   Share the snapshot, if possible.
-    -   GitHub Readme Stats' live link
--   What actually happens
--   What you expected would happen
--   Notes (possibly including why you think this might be happening or stuff you tried that didn't work)
+**Great bug reports** tend to have:
 
-People ❤️ thorough bug reports. I'm not even kidding.
+- A quick summary and/or background
+- Steps to reproduce:
+  - Be specific!
+  - Include a snapshot or screenshot if possible.
+  - Provide a live link to the affected card (e.g., `https://gh-readme-profile.vercel.app/api?username=...`)
+- What actually happens
+- What you expected to happen
+- Notes (possible causes, things you tried that didn't work)
 
+People ❤️ thorough bug reports, we’re not even kidding.
 
-### 😎 Feature Request
+### Feature Requests
 
-**Great Feature Requests** tend to have:
+**Great feature requests** tend to have:
 
--   A quick idea summary
--   What & why do you want to add the specific feature
--   Additional context like images, links to resources to implement the feature, etc.
+- A clear idea summary
+- What you want to add and why
+- Additional context (images, links to resources, implementation ideas)
 
-## 📖 License
+## License
 
-By contributing, you agree that your contributions will be licensed under its [MIT License](./LICENSE).
+By contributing, you agree that your contributions will be licensed under the project's [MIT License](/LICENSE).