|
| 1 | +# Contributing to recode hive |
| 2 | + |
| 3 | +Thank you for your interest in contributing to **recode hive**! We're excited to have you join our community of learners, developers, and open-source enthusiasts. This guide will help you get started with contributing to our project. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 📋 Table of Contents |
| 8 | + |
| 9 | +- [Code of Conduct](#code-of-conduct) |
| 10 | +- [How Can I Contribute?](#how-can-i-contribute) |
| 11 | +- [Getting Started](#getting-started) |
| 12 | +- [Development Setup](#development-setup) |
| 13 | +- [Making Changes](#making-changes) |
| 14 | +- [Submitting Changes](#submitting-changes) |
| 15 | +- [Community](#community) |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 🤝 Code of Conduct |
| 20 | + |
| 21 | +By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to providing a welcoming and inclusive environment for all contributors, regardless of experience level, background, or identity. |
| 22 | + |
| 23 | +**Key principles:** |
| 24 | +- Be respectful and constructive in all interactions |
| 25 | +- Welcome newcomers and help them feel included |
| 26 | +- Give and receive feedback gracefully |
| 27 | +- Focus on what's best for the community |
| 28 | +- Show empathy towards other community members |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +## 💡 How Can I Contribute? |
| 33 | + |
| 34 | +There are many ways to contribute to recode hive: |
| 35 | + |
| 36 | +### 🐛 Reporting Bugs |
| 37 | + |
| 38 | +### ✨ Suggesting Enhancements |
| 39 | + |
| 40 | +### 📝 Improving Documentation |
| 41 | + |
| 42 | +### 💻 Contributing Code |
| 43 | + |
| 44 | +### 🎨 Design Contributions |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +## 🚀 Getting Started |
| 49 | + |
| 50 | +### Prerequisites |
| 51 | + |
| 52 | +Before you begin, ensure you have the following installed: |
| 53 | + |
| 54 | +- **Node.js** ≥ 18 ([Download](https://nodejs.org/)) |
| 55 | +- **Git** ([Download](https://git-scm.com/)) |
| 56 | +- **Docker** (optional, but recommended) ([Download](https://docs.docker.com/engine/install/)) |
| 57 | +- A code editor (we recommend [VS Code](https://code.visualstudio.com/)) |
| 58 | + |
| 59 | +### Fork and Clone |
| 60 | + |
| 61 | +1. **Fork the repository** by clicking the "Fork" button at the top right of the [GitHub page](https://github.com/recodehive/recode-website) |
| 62 | + |
| 63 | +2. **Clone your fork** to your local machine: |
| 64 | + |
| 65 | +```bash |
| 66 | +git clone https://github.com/YOUR-USERNAME/recode-website.git |
| 67 | +cd recode-website |
| 68 | +``` |
| 69 | + |
| 70 | +3. **Add the upstream remote** to stay synced with the main repository: |
| 71 | + |
| 72 | +```bash |
| 73 | +git remote add upstream https://github.com/recodehive/recode-website.git |
| 74 | +``` |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +## 🛠️ Development Setup |
| 79 | + |
| 80 | +Choose your preferred setup method: |
| 81 | + |
| 82 | +### Option 1: Docker (Recommended) |
| 83 | + |
| 84 | +**Build and run with Docker:** |
| 85 | + |
| 86 | +```bash |
| 87 | +# Build the image |
| 88 | +docker build -t recodehive-app . |
| 89 | + |
| 90 | +# Run the container |
| 91 | +docker run -p 3000:3000 recodehive-app |
| 92 | +``` |
| 93 | + |
| 94 | +**Or use Docker Compose for hot-reload:** |
| 95 | + |
| 96 | +```bash |
| 97 | +docker-compose up |
| 98 | +``` |
| 99 | + |
| 100 | +### Option 2: Traditional Setup |
| 101 | + |
| 102 | +**Install dependencies:** |
| 103 | + |
| 104 | +```bash |
| 105 | +npm install |
| 106 | +``` |
| 107 | + |
| 108 | +**Start the development server:** |
| 109 | + |
| 110 | +```bash |
| 111 | +npm run start |
| 112 | +``` |
| 113 | + |
| 114 | +**Your application will be available at** http://localhost:3000 |
| 115 | + |
| 116 | +### Verify Your Setup |
| 117 | + |
| 118 | +Once running, you should see the recode hive homepage. Try navigating through the tutorials and documentation to ensure everything works correctly. |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +## 🔧 Making Changes |
| 123 | + |
| 124 | +### Create a Branch |
| 125 | + |
| 126 | +Always create a new branch for your changes: |
| 127 | + |
| 128 | +```bash |
| 129 | +git checkout -b feature/your-feature-name |
| 130 | +``` |
| 131 | + |
| 132 | +**Branch naming conventions:** |
| 133 | +- `feature/` - for new features (e.g., `feature/add-python-tutorial`) |
| 134 | +- `fix/` - for bug fixes (e.g., `fix/navigation-bug`) |
| 135 | +- `docs/` - for documentation (e.g., `docs/improve-contributing-guide`) |
| 136 | +- `style/` - for styling changes (e.g., `style/update-button-colors`) |
| 137 | +- `refactor/` - for code refactoring (e.g., `refactor/simplify-api-calls`) |
| 138 | + |
| 139 | +### Write Quality Code |
| 140 | + |
| 141 | +Follow these guidelines while coding: |
| 142 | + |
| 143 | +- **Keep it simple** - Write clear, readable code |
| 144 | +- **Comment when necessary** - Explain complex logic |
| 145 | +- **Test your changes** - Ensure everything works as expected |
| 146 | +- **Follow existing patterns** - Maintain consistency with the codebase |
| 147 | +- **Make atomic commits** - Each commit should represent a single logical change |
| 148 | + |
| 149 | +### Commit Your Changes |
| 150 | + |
| 151 | +Write clear, descriptive commit messages: |
| 152 | + |
| 153 | +```bash |
| 154 | +git add . |
| 155 | +git commit -m "Add: brief description of your changes" |
| 156 | +``` |
| 157 | + |
| 158 | +**Commit message format:** |
| 159 | +- `Add:` - for new features |
| 160 | +- `Fix:` - for bug fixes |
| 161 | +- `Update:` - for updates to existing features |
| 162 | +- `Remove:` - for removing features or files |
| 163 | +- `Refactor:` - for code refactoring |
| 164 | +- `Docs:` - for documentation changes |
| 165 | +- `Style:` - for formatting changes |
| 166 | + |
| 167 | +**Example:** |
| 168 | +```bash |
| 169 | +git commit -m "Add: Python tutorial for data structures" |
| 170 | +git commit -m "Fix: Navigation menu not displaying on mobile" |
| 171 | +git commit -m "Docs: Update installation instructions" |
| 172 | +``` |
| 173 | + |
| 174 | +--- |
| 175 | + |
| 176 | +## 📤 Submitting Changes |
| 177 | + |
| 178 | +### Sync with Upstream |
| 179 | + |
| 180 | +Before submitting, ensure your branch is up to date: |
| 181 | + |
| 182 | +```bash |
| 183 | +# Fetch upstream changes |
| 184 | +git fetch upstream |
| 185 | + |
| 186 | +# Merge upstream changes into your branch |
| 187 | +git merge upstream/main |
| 188 | +``` |
| 189 | + |
| 190 | +### Push Your Changes |
| 191 | + |
| 192 | +```bash |
| 193 | +git push origin feature/your-feature-name |
| 194 | +``` |
| 195 | + |
| 196 | +### Create a Pull Request |
| 197 | + |
| 198 | +1. **Navigate to your fork** on GitHub |
| 199 | +2. **Click "Compare & pull request"** |
| 200 | +3. **Fill out the PR template** with: |
| 201 | + - A clear, descriptive title |
| 202 | + - Detailed description of your changes |
| 203 | + - Reference any related issues (e.g., "Closes #123") |
| 204 | + - Screenshots (if applicable) |
| 205 | + - Testing steps |
| 206 | + |
| 207 | +4. **Submit the pull request** |
| 208 | + |
| 209 | +### PR Review Process |
| 210 | + |
| 211 | +- A maintainer will review your PR |
| 212 | +- You may be asked to make changes |
| 213 | +- Be responsive to feedback and questions |
| 214 | +- Once approved, your PR will be merged! |
| 215 | + |
| 216 | +--- |
| 217 | + |
| 218 | + |
| 219 | +## 💬 Community |
| 220 | + |
| 221 | +### Get Help |
| 222 | + |
| 223 | +Need assistance? We're here to help! |
| 224 | + |
| 225 | +- **Discord:** Join our [Discord server](https://discord.gg/Yxv9RA3r) |
| 226 | +- **GitHub Discussions:** Ask questions in [Discussions](https://github.com/recodehive/recode-website/discussions) |
| 227 | +- **Issues:** Check existing [issues](https://github.com/recodehive/recode-website/issues) or create a new one |
| 228 | + |
| 229 | +### Stay Connected |
| 230 | + |
| 231 | +- **Website:** [recodehive.com](https://recodehive.com/) |
| 232 | +- **LinkedIn:** [Sanjay K V](https://www.linkedin.com/in/sanjay-k-v/) |
| 233 | +- **Twitter:** [@sanjay_kv_](https://x.com/sanjay_kv_) |
| 234 | +- **YouTube:** [@RecodeHive](https://www.youtube.com/@RecodeHive) |
| 235 | +- **Newsletter:** [Subscribe](https://recodehive.substack.com/) |
| 236 | + |
| 237 | +### Video Tutorial |
| 238 | + |
| 239 | +New to contributing? Watch this helpful video: |
| 240 | + |
| 241 | +<div> |
| 242 | + <a href="https://www.loom.com/share/c8d8d5f0c2534a1f86fc510dcef52ee0"> |
| 243 | + <p>How to Contribute to this Repo | How to Setup - Watch Video</p> |
| 244 | + </a> |
| 245 | +</div> |
| 246 | + |
| 247 | +--- |
| 248 | + |
| 249 | +## 🎯 Contribution Workflow |
| 250 | + |
| 251 | +```mermaid |
| 252 | +flowchart LR |
| 253 | + A[Fork Repository] --> B[Clone to Local] |
| 254 | + B --> C[Create New Branch] |
| 255 | + C --> D[Make Changes] |
| 256 | + D --> E[Test Changes] |
| 257 | + E --> F[Commit Changes] |
| 258 | + F --> G[Push to Fork] |
| 259 | + G --> H[Create Pull Request] |
| 260 | + H --> I[Address Feedback] |
| 261 | + I --> J[PR Merged] |
| 262 | +``` |
| 263 | + |
| 264 | +--- |
| 265 | + |
| 266 | +## 🏆 Recognition |
| 267 | + |
| 268 | +All contributors are recognized in our [README](README.md#-contributors)! Your contributions, big or small, help make recode hive better for everyone. |
| 269 | + |
| 270 | +--- |
| 271 | + |
| 272 | +## ❓ Questions? |
| 273 | + |
| 274 | +If you have any questions that aren't covered in this guide, feel free to: |
| 275 | + |
| 276 | +- Open an issue with the "question" label |
| 277 | +- Ask in our Discord community |
| 278 | +- Reach out to the maintainers |
| 279 | + |
| 280 | +--- |
| 281 | + |
| 282 | +## 📄 License |
| 283 | + |
| 284 | +By contributing to recode hive, you agree that your contributions will be licensed under the [MIT License](LICENSE). |
| 285 | + |
| 286 | +--- |
| 287 | + |
| 288 | +<div align="center"> |
| 289 | + |
| 290 | +**Thank you for contributing to recode hive! 🎉** |
| 291 | + |
| 292 | +Together, we're building a platform that empowers developers worldwide. Every contribution matters, and we're grateful for yours. |
| 293 | + |
| 294 | +<p align="center"> |
| 295 | + <img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="600"> |
| 296 | +</p> |
| 297 | + |
| 298 | +**Happy Contributing! 💻✨** |
| 299 | + |
| 300 | +Made with ❤️ by the recode hive community |
| 301 | + |
| 302 | +</div> |
0 commit comments