Skip to content

Commit 32df44a

Browse files
authored
Merge pull request #792 from sheikhlimon/docs/standardize-project-name
style/docs: unify 'recode hive' branding and update contributing guidelines
2 parents d2e9516 + 57a7c52 commit 32df44a

File tree

36 files changed

+192
-165
lines changed

36 files changed

+192
-165
lines changed

CODE_OF_CONDUCT.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
**🌐 Documentation Code of Conduct — Recode-Website 🌐**
1+
**🌐 Documentation Code of Conduct — recode-website 🌐**
22

33
**🤝 Our Commitment**
44

5-
Recode-Website is built to empower learners, developers, and open-source contributors from all walks of life. Whether you’re fixing a typo or designing a whole new feature, every contribution matters. We’re committed to ensuring a respectful, welcoming, and inclusive space for everyone.
5+
recode-website is built to empower learners, developers, and open-source contributors from all walks of life. Whether you’re fixing a typo or designing a whole new feature, every contribution matters. We’re committed to ensuring a respectful, welcoming, and inclusive space for everyone.
66

77
---
88

99
**💡 Our Core Values**
1010

11-
We believe the Recode community thrives when we:
11+
We believe the recode hive community thrives when we:
1212
- 💬 Encourage open communication and knowledge sharing
1313
- 🧠 Welcome new ideas, diverse perspectives, and honest questions
1414
- 🙌 Support and uplift contributors at all skill levels
@@ -31,11 +31,11 @@ To maintain a safe and productive space, we do not tolerate:
3131

3232
**🧭 Scope of This Code**
3333

34-
This Code of Conduct applies to all spaces where the Recode project is represented:
34+
This Code of Conduct applies to all spaces where the recode hive project is represented:
3535
- 📌 GitHub repository & discussions
3636
- 📌 Pull requests, issues, and commit comments
3737
- 📌 Project-related events, forums, and social media
38-
- 📌 Any other platform or medium connected to Recode
38+
- 📌 Any other platform or medium connected to recode hive
3939

4040
---
4141

@@ -62,20 +62,20 @@ We ask all contributors to:
6262
- ✅ Maintain integrity and credit all sources
6363
- ✅ Embrace learning and be open to feedback
6464
- ✅ Avoid offensive, unethical, or AI-generated content without review
65-
- ✅ Help make Recode a safe, beginner-friendly environment
65+
- ✅ Help make recode hive a safe, beginner-friendly environment
6666

6767
---
6868

6969
**💫 Our Vision**
7070

71-
*Recode-Website* is more than a project—it’s a platform for exploration, skill-building, and meaningful collaboration. Let’s code not just with logic, but with empathy and purpose. Together, we can create tech that inspires and includes. 💻🌱
71+
*recode-website* is more than a project—it’s a platform for exploration, skill-building, and meaningful collaboration. Let’s code not just with logic, but with empathy and purpose. Together, we can create tech that inspires and includes. 💻🌱
7272

7373
---
7474

7575
**📄 Attribution**
7676

7777
This Code of Conduct aligns with the principles of *GSSoC’25* and reflects our collective commitment to mentorship, inclusivity, and ethical open-source contribution.
7878

79-
Inspired by [Contributor Covenant](https://www.contributor-covenant.org/version/3/0/code_of_conduct/) and has been adapted specifically for Recode-Website as part of the GSSoC’25 Open Source Contributions initiative.
79+
Inspired by [Contributor Covenant](https://www.contributor-covenant.org/version/3/0/code_of_conduct/) and has been adapted specifically for recode-website as part of the GSSoC’25 Open Source Contributions initiative.
8080

81-
Modifications include beginner-friendly practices, inclusive open-source standards, and collaboration-focused values in line with GSSoC’s vision of mentorship and diversity in tech.
81+
Modifications include beginner-friendly practices, inclusive open-source standards, and collaboration-focused values in line with GSSoC’s vision of mentorship and diversity in tech.

Documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Building a GitHub Organization Leaderboard: A Deep Dive into Recode Hive's Implementation
1+
# Building a GitHub Organization Leaderboard: A Deep Dive into recode hive's Implementation
22

3-
Ever wondered how to build a live leaderboard that tracks contributions across an entire GitHub organization? Let me walk you through how we built ours at Recode Hive. This isn't your typical "fetch and display" tutorial - we're talking about handling rate limits, caching strategies, time-based filtering, and creating a smooth user experience that doesn't make the GitHub API cry.
3+
Ever wondered how to build a live leaderboard that tracks contributions across an entire GitHub organization? Let me walk you through how we built ours at recode hive. This isn't your typical "fetch and display" tutorial - we're talking about handling rate limits, caching strategies, time-based filtering, and creating a smooth user experience that doesn't make the GitHub API cry.
44

55
## What We're Building
66

@@ -557,7 +557,7 @@ Response Example:
557557
"repos_url": "https://api.github.com/orgs/recodehive/repos",
558558
"avatar_url": "https://avatars.githubusercontent.com/u/98765?v=4",
559559
"description": "Community-driven open source projects",
560-
"name": "Recode Hive",
560+
"name": "recode hive",
561561
"company": null,
562562
"blog": "https://recodehive.com",
563563
"location": "Worldwide",

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Recode Hive
3+
Copyright (c) 2025 recode hive
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<a href="https://www.recodehive.com">
3-
<img src="static/icons/Logo-512X512.png" alt="Recode logo" width="150" />
3+
<img src="static/icons/Logo-512X512.png" alt="recode hive logo" width="150" />
44
</a>
55
</div>
66
<h1 align="center">recode hive</h1>
@@ -17,32 +17,29 @@
1717
<a href="https://github.com/recodehive/recode-website/LICENSE"><img src="https://img.shields.io/github/license/recodehive/recode-website?color=2b9348" alt="License Badge"/></a>
1818
[![](https://visitcount.itsvg.in/api?id=Opensource-practice&label=Profile%20Views&color=0&icon=5&pretty=true)](https://visitcount.itsvg.in)
1919
<!-- ALL-CONTRIBUTORS-BADGE:END -->
20-
This is the all in one place for documentation help regarding How to contribute.
20+
This is your all-in-one resource for documentation and guidance on how to contribute.
2121
</div>
2222

23+
---
2324

24-
##
25-
26-
Now, resolve your all doubts and communicate with our all contributors.
25+
Have questions or need guidance? Our contributors are happy to help! Join the conversation and get your doubts resolved:
2726

2827
[![](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://discord.gg/Yxv9RA3r) [![Follow Us On LinkedIn](https://img.shields.io/badge/Follow%20on-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/sanjay-k-v/)
2928

30-
3129
## Getting Started
3230

33-
To get started with contributing to Recode-Hive, please refer to our [Contributing Guidelines](community/contributing-guidelines.md).
31+
To get started with contributing to recode hive, please refer to our [Contributing Guidelines](community/contributing-guidelines.md).
3432

3533
<div>
3634
<a href="https://www.loom.com/share/c8d8d5f0c2534a1f86fc510dcef52ee0">
37-
<p>How to Contribute to this repo | How to Setup - Watch Video</p>
35+
<p>How to Contribute to this Repo | How to Setup - Watch Video</p>
3836
</a>
3937
<a href="https://www.loom.com/share/c8d8d5f0c2534a1f86fc510dcef52ee0">
4038
<img style="max-width:700px;" src="https://cdn.loom.com/sessions/thumbnails/c8d8d5f0c2534a1f86fc510dcef52ee0-30cac2eeec09a266-full-play.gif">
4139
</a>
4240
</div>
4341
Follow these steps:
4442

45-
4643
```mermaid
4744
flowchart LR
4845
Fork[Fork the project]-->branch[Create a New Branch]
@@ -51,38 +48,41 @@ flowchart LR
5148
commit -->|Finally|creatpr((Create a Pull Request))
5249
```
5350

54-
1. **Clone the repository:**
51+
1. **Clone the repository:**
52+
5553
```bash
5654
git clone https://github.com/your-username/recodehive-website.git
5755
```
5856

5957
2. **Navigate to the project directory:**
58+
6059
```bash
6160
cd recode-website
6261
```
6362

6463
3. **Prerequisites**
64+
6565
- [Docker](https://docs.docker.com/engine/install/) installed
6666
- Docker compose installed (Optional)
6767

68-
6968
4. **Build the Docker Image:**
70-
Only do this if you are setting up this project locally for the first time. (only build)
69+
Only do this if you are setting up this project locally for the first time. (only build)
7170

72-
```bash
73-
docker build -t recodehive-app .
74-
```
71+
```bash
72+
docker build -t recodehive-app .
73+
```
7574

76-
5. Run the Container
77-
```bash
78-
docker run -p 3000:3000 recodehive-app
79-
```
75+
5. **Run the Container:**
76+
77+
```bash
78+
docker run -p 3000:3000 recodehive-app
79+
```
8080

81-
This command will start a development server and open the application in your default web browser.
81+
This command will start a development server and open the application in your default web browser.
8282

8383
## ⚡ Local Development with Docker Compose & Hot Reload
8484

85-
For an even smoother experience, contributors can leverage **Docker Compose with hot reloading**.
85+
For an even smoother experience, contributors can leverage **Docker Compose with hot-reloading**.
8686
This lets you see code changes instantly at [http://localhost:3000](http://localhost:3000) without rebuilding or restarting containers.
8787

8888
### 🏃 Quick Start
@@ -94,12 +94,13 @@ docker-compose up
9494
```
9595

9696
### 🚢 Production Deployment
97+
9798
```bash
9899
npm run build
99100
npm run serve
100101
```
101102

102-
**If you'd like to contribute to CodeHarborHub, please follow these guidelines:**
103+
**If you'd like to contribute to recode hive, please follow these guidelines:**
103104

104105
- **Fork** the repository and clone it locally.
105106
- Create a new branch for your feature or bug fix: `git checkout -b feature-name`
@@ -112,16 +113,16 @@ npm run serve
112113

113114
```
114115
recode-website/
115-
|
116+
|
116117
├── .github/ 🔹 GitHub meta files
117118
| ├── ISSUE_TEMPLATE/
118119
| ├── workflows/
119120
| └── pull_request_template.md
120-
├── blog/ 🔹Project Blog
121+
├── blog/ 🔹Project Blog
121122
| ├── git-coding-agent/
122123
| ├── google-backlinks/
123124
| ├──...
124-
├── community/ 🔹 Contributor Docs
125+
├── community/ 🔹 Contributor Docs
125126
| ├── contributing-guidelines.md
126127
| ├── index.md
127128
| ├── our-documentation.md
@@ -130,7 +131,7 @@ recode-website/
130131
| ├── GitHub/
131132
| ├── Google-Student-Ambassador/
132133
| ├── ...
133-
├── src/ 🔹Source Code
134+
├── src/ 🔹Source Code
134135
| └── components/
135136
| ├── css/
136137
| └── custom.css
@@ -152,7 +153,7 @@ recode-website/
152153
├── CODE_OF_CONDUCT.md
153154
├── LICENSE
154155
├── README.md
155-
└── ...
156+
└── ...
156157
```
157158

158159
## License
@@ -178,27 +179,27 @@ This project is licensed under the [MIT License](LICENSE).
178179
![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/RecodeHive/recode-website)
179180
![Last commit](https://img.shields.io/github/last-commit/RecodeHive/recode-website)
180181

181-
182182
## Contributors
183183

184184
<a href="https://github.com/RecodeHive/recode-website/graphs/contributors">
185185
<img src="https://contrib.rocks/image?repo=RecodeHive/recode-website" />
186186
</a>
187187

188-
189188
<div align="center">
190189

191-
Happy open-source contributions and here’s to your career success! 🎉
190+
Happy open-source contributionshere’s to your career success! 🎉
192191

193192
<p align="center">
194193
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="600">
195194
</p>
196195

197-
### recode-hive 2025
196+
### recode hive
198197

199198
[Website](https://recodehive.com/) | [Instagram](https://www.instagram.com/nomad_brains/) | [LinkedIn](https://www.linkedin.com/in/sanjay-k-v/) | [Twitter](https://x.com/sanjay_kv_) | [YouTube](https://www.youtube.com/@RecodeHive)<br>
199+
200200
**🔔 Don’t miss a beat!** <br>
201-
Subscribe to receive our newsletter directly in your inbox for the latest career insights & tailored to your journey.<br>
201+
Subscribe to receive our newsletter directly in your inbox for the latest career insights & tailored to your journey.<br>
202+
202203
[![Subscribe to Our Newsletter](https://img.shields.io/badge/Subscribe%20to%20Our%20Newsletter-%F0%9F%93%A9-blue)](https://recodehive.substack.com/) <br>
203204

204205
<a href="#top">

blog/authors.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ajay-dhangar:
1010
1111
sanjay-kv:
1212
name: Sanjay Viswanthan
13-
title: Founder at Recode Hive
13+
title: Founder at recode hive
1414
url: www.sanjaykv.com
1515
image_url: https://avatars.githubusercontent.com/u/30715153?v=4
1616
@@ -96,4 +96,4 @@ Aditya-Singh-Rathore:
9696
socials:
9797
linkedin: aditya-singh-rathore0017
9898
github: Adez017
99-
instagram: _aaditya_.017
99+
instagram: _aaditya_.017

blog/google-deepmind/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Google’s advanced mechanics and man-made reasoning endeavors were put under th
137137

138138
## 📍 Final Verdict
139139

140-
In conclusion, we hope you found this guide helpful in exploring: For more articles like this, check out the **Data Science section** of RecodeHive.
140+
In conclusion, we hope you found this guide helpful in exploring: For more articles like this, check out the **Data Science Section** of recode hive.
141141

142142

143143
<GiscusComments/>

community/contributing-guidelines.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ sidebar_label: Contributing Guidelines
55
sidebar_position: 2
66
---
77

8-
Thank you for considering contributing to CodeHarborHub! We welcome contributions from everyone. Whether you're a seasoned developer or just starting out, there are many ways to get involved and help improve CodeHarborHub. This document outlines the guidelines for contributing to this project.
8+
Thank you for considering contributing to recode hive! We welcome contributions from everyone. Whether you're a seasoned developer or just starting out, there are many ways to get involved and help improve recode hive. This document outlines the guidelines for contributing to this project.
99

1010
## Getting Started
1111

12-
To get started with contributing to Recode-Hive, please refer to our [Contributing Guidelines](/community/contributing-guidelines).
12+
To get started with contributing to recode hive, please refer to our [Contributing Guidelines](/community/contributing-guidelines).
1313

1414
Follow these steps:
1515

16-
1716
```mermaid
1817
flowchart LR
1918
Fork[Fork the project]-->branch[Create a New Branch]
@@ -22,31 +21,35 @@ flowchart LR
2221
commit -->|Finally|creatpr((Create a Pull Request))
2322
```
2423

25-
1. **Clone the repository:**
24+
1. **Clone the repository:**
25+
2626
```bash
2727
git clone https://github.com/your-username/recodehive-website.git
2828
```
2929

3030
2. **Navigate to the project directory:**
31+
3132
```bash
3233
cd recodehive-website
3334
```
3435

3536
3. **Install dependencies:**
37+
3638
```bash
3739
npm install
3840
```
3941

4042
4. **Running the Application:**
4143

42-
Once you have installed the dependencies, you can run the application locally using:
43-
```bash
44-
npm start
45-
```
44+
Once you have installed the dependencies, you can run the application locally using:
45+
46+
```bash
47+
npm start
48+
```
4649

47-
This command will start a development server and open the application in your default web browser.
50+
This command will start a development server and open the application in your default web browser.
4851

49-
**If you'd like to contribute to CodeHarborHub, please follow these guidelines:**
52+
**If you'd like to contribute to recode hive, please follow these guidelines:**
5053

5154
- **Fork** the repository and clone it locally.
5255
- Create a new branch for your feature or bug fix: `git checkout -b feature-name`
@@ -55,7 +58,24 @@ flowchart LR
5558
- Push to the branch: `git push origin feature-name`
5659
- Submit a pull request detailing your changes.
5760

61+
### Branding & Naming Conventions
62+
63+
- Use **`recode hive`** in lowercase for all mentions of the project name.
64+
- Update any headers, titles, or utility constants accordingly.
65+
66+
### Formatting
67+
68+
- Follow the existing code style for spacing, indentation, and Markdown formatting.
69+
- Use Prettier or ESLint to auto-format files before committing.
70+
71+
## Exceptions to Lowercase Branding
72+
73+
While we use lowercase **`recode hive`** throughout the project for consistency, there are some places where the exact repository name with capitalization must be used:
74+
75+
- Repository-specific badges (e.g., [contrib.rocks](https://contrib.rocks))
76+
- GitHub repository URLs in tools or badges
77+
- Any external services that require exact repo names
5878

5979
## License
6080

61-
This project is licensed under the [MIT License](/License).
81+
This project is licensed under the [MIT License](/License).

0 commit comments

Comments
 (0)