From 91f5a8b15f5f4414b336ef8dfd3a1284712b5137 Mon Sep 17 00:00:00 2001 From: KaifAhmad1 Date: Tue, 27 Jan 2026 11:46:34 +0530 Subject: [PATCH] docs: update CONTRIBUTING.md and CONTRIBUTORS.md with improved formatting and fork mentions --- CONTRIBUTING.md | 8 +++- CONTRIBUTORS.md | 113 ++++++++++++++++++++++++++++-------------------- 2 files changed, 72 insertions(+), 49 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c07c8d1..23ab0fdb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ Thank you for your interest in contributing! Every contribution, no matter how small, is valuable. ๐ŸŽ‰ +โญ **Give us a Star** โ€ข ๐Ÿด **[Fork Semantica](https://github.com/Hawksight-AI/semantica/fork)** โ€ข ๐Ÿ’ฌ **Join our [Discord](https://discord.gg/vqRt2qbx)** + > **New to contributing?** Start with a [`good first issue`](https://github.com/Hawksight-AI/semantica/labels/good%20first%20issue) or join our [Discord](https://discord.gg/vqRt2qbx) community. --- @@ -9,7 +11,7 @@ Thank you for your interest in contributing! Every contribution, no matter how s ## ๐Ÿš€ Quick Start 1. Find a [`good first issue`](https://github.com/Hawksight-AI/semantica/labels/good%20first%20issue) -2. Fork & clone the repository +2. [Fork Semantica](https://github.com/Hawksight-AI/semantica/fork) & clone the repository 3. Make your changes 4. Submit a pull request! @@ -133,6 +135,8 @@ Thank you for your interest in contributing! Every contribution, no matter how s ### 1. Fork & Clone +First, [fork Semantica](https://github.com/Hawksight-AI/semantica/fork) on GitHub, then: + ```bash git clone https://github.com/your-username/semantica.git cd semantica @@ -358,3 +362,5 @@ This project follows a [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful and **Thank you for contributing!** ๐Ÿš€ Every contribution matters - whether it's a single line of code, a typo fix, a helpful answer, or a bug report. We appreciate you! ๐Ÿ™ + +โญ **Give us a Star** โ€ข ๐Ÿด **[Fork Semantica](https://github.com/Hawksight-AI/semantica/fork)** โ€ข ๐Ÿ’ฌ **Join our [Discord](https://discord.gg/vqRt2qbx)** diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index c99d25cd..f26b5726 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -4,44 +4,31 @@ Thank you to all the people who have contributed to Semantica! ๐ŸŽ‰ This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome! -## How to Contribute +โญ **Give us a Star** โ€ข ๐Ÿด **Fork us** โ€ข ๐Ÿ’ฌ **Join our [Discord](https://discord.gg/vqRt2qbx)** -We welcome contributions of all kinds! Whether you're: -- Writing code -- Improving documentation -- Reporting bugs -- Suggesting features -- Answering questions -- Reviewing pull requests -- Sharing use cases -- Creating examples - -All contributions are valuable and appreciated! +--- ## Contribution Types +We recognize all types of contributions: + - ๐Ÿ’ป **Code**: Writing code, fixing bugs, implementing features - ๐Ÿ“ **Documentation**: Writing docs, tutorials, examples +- ๐Ÿงช **Testing**: Writing tests, improving test coverage - ๐Ÿ› **Bug Reports**: Finding and reporting bugs - ๐Ÿ’ก **Ideas**: Suggesting new features or improvements - ๐ŸŽจ **Design**: UI/UX improvements, graphics, branding -- ๐Ÿ“– **Examples**: Creating code examples and tutorials -- ๐Ÿ” **Testing**: Writing tests, improving test coverage -- ๐Ÿ’ฌ **Answering Questions**: Helping others in discussions -- ๐Ÿ“ข **Talks**: Giving talks, presentations, workshops -- ๐ŸŒ **Translation**: Translating documentation +- ๐ŸŽจ **Cookbook**: Creating tutorials and examples +- ๐Ÿ’ฌ **Community**: Answering questions, reviewing PRs +- ๐ŸŽ“ **Education**: Blog posts, video tutorials, talks, workshops - ๐Ÿ”ง **Tools**: Creating tools, scripts, integrations - ๐Ÿ“ฆ **Packaging**: Improving build, release, distribution - โš ๏ธ **Security**: Reporting security vulnerabilities -- ๐ŸŽ“ **Education**: Teaching, mentoring, tutorials -- ๐Ÿ“น **Video**: Creating video content, tutorials -- ๐ŸŽต **Audio**: Podcasts, audio content -- ๐Ÿ“ธ **Photography**: Screenshots, images -- ๐Ÿ”ฌ **Research**: Research, analysis, studies -- ๐Ÿ’ฐ **Financial**: Sponsoring, funding - ๐Ÿ—๏ธ **Infrastructure**: CI/CD, hosting, infrastructure - ๐Ÿš‡ **Maintenance**: Maintenance, triage, project management +--- + ## Contributors @@ -50,48 +37,78 @@ All contributions are valuable and appreciated! +--- + ## Recognition -### Top Contributors +All contributors are recognized in: -Contributors are recognized based on their contributions to the project. Recognition includes: +- This contributors list +- [GitHub contributors page](https://github.com/Hawksight-AI/semantica/graphs/contributors) +- Release notes for significant contributions +- Community appreciation -- Listing in this file -- GitHub contributor statistics -- Special mentions in release notes -- Featured showcases for significant contributions - -### Hall of Fame - -Special recognition for exceptional contributions: - -- **Coming soon** - We'll feature outstanding contributors here! +--- ## How to Add Yourself -If you've contributed to Semantica and want to be added to this list: +### Automatic Recognition -1. **Automatic**: If you've made a commit, you'll appear in [GitHub's contributors graph](https://github.com/Hawksight-AI/semantica/graphs/contributors) -2. **Manual**: Open a PR adding yourself to this file, or use the [@all-contributors bot](https://allcontributors.org/docs/en/bot/usage) +If you've made a commit, you'll automatically appear in [GitHub's contributors graph](https://github.com/Hawksight-AI/semantica/graphs/contributors). -Example: -```markdown -- [Your Name](https://github.com/yourusername) - ๐Ÿ’ป ๐Ÿ“ ๐Ÿ› -``` +### Using All-Contributors Bot -## All Contributors Bot - -We use the [all-contributors](https://allcontributors.org) bot to automatically recognize contributors. To add a contributor, comment on an issue or PR: +Comment on any issue or PR with: ``` @all-contributors please add @username for code, docs, bug ``` -## Thank You! +**Examples:** -Every contribution, no matter how small, helps make Semantica better. Thank you for being part of our community! +``` +@all-contributors please add @johndoe for code +@all-contributors please add @janedoe for docs, bug +@all-contributors please add @devuser for code, test, maintenance +``` + +### Manual Addition + +Open a PR adding yourself to this file: + +```markdown +- [Your Name](https://github.com/yourusername) - ๐Ÿ’ป ๐Ÿ“ ๐Ÿ› +``` --- -**Want to contribute?** Check out our [Contributing Guide](CONTRIBUTING.md) to get started! +## Contribution Type Codes +When using the all-contributors bot, use these codes: + +- `code` - Code contributions +- `doc` - Documentation +- `test` - Testing +- `bug` - Bug reports +- `ideas` - Feature requests/ideas +- `design` - Design work +- `example` - Cookbook/examples +- `question` - Answering questions +- `talk` - Talks/presentations +- `tool` - Tools/integrations +- `packaging` - Packaging/distribution +- `security` - Security reports +- `infra` - Infrastructure +- `maintenance` - Maintenance + +See [all-contributors specification](https://allcontributors.org/docs/en/emoji-key) for complete list. + +--- + +## Thank You! + +Every contribution, no matter how small, helps make Semantica better. Thank you for being part of our community! ๐Ÿ™ + +**Want to contribute?** + +โญ Give us a Star โ€ข ๐Ÿด [Fork us](https://github.com/Hawksight-AI/semantica/fork) โ€ข Check out our [Contributing Guide](CONTRIBUTING.md) to get started!