|
1 | | -# community-website |
| 1 | + |
| 2 | +# 🚀 Contribution Workflow |
| 3 | + |
| 4 | +Follow the steps below to contribute effectively: |
| 5 | + |
| 6 | +1. **Fork the Repository:** |
| 7 | + - Navigate to the `dev` branch and fork the repository onto your personal GitHub account. |
| 8 | + |
| 9 | +2. **Clone the Repository:** |
| 10 | + - Clone the forked repository to your local development environment. |
| 11 | + ```bash |
| 12 | + git clone https://github.com/your-username/community-website.git |
| 13 | + ``` |
| 14 | + |
| 15 | +3. **Create a New Branch Locally:** |
| 16 | + - Before making any changes, create a new branch using the required naming convention: |
| 17 | + ```bash |
| 18 | + git checkout -b feature/your-feature-name |
| 19 | + ``` |
| 20 | + **Branch Naming Schema:** `feature/your-feature-name` or `fix/your-bug-description` |
| 21 | + |
| 22 | +4. **Make Your Changes:** |
| 23 | + - Add your code, features, or bug fixes. |
| 24 | + |
| 25 | +5. **Commit Your Changes:** |
| 26 | + - Commit your changes locally with meaningful messages: |
| 27 | + ```bash |
| 28 | + git add . |
| 29 | + git commit -m "feat: Added new feature" |
| 30 | + ``` |
| 31 | + |
| 32 | +6. **Push to Your Repository:** |
| 33 | + - Push the changes to your forked repository: |
| 34 | + ```bash |
| 35 | + git push origin feature/your-feature-name |
| 36 | + ``` |
| 37 | + |
| 38 | +7. **Create a Pull Request (PR):** |
| 39 | + - Go to the community repository and create a PR from your local branch to the `dev` branch. |
| 40 | + |
| 41 | +8. **Code Review:** |
| 42 | + - Your PR will be reviewed by maintainers. Make necessary changes if requested. |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 💡 Contribution Tips |
| 47 | + |
| 48 | +- Always follow the coding style and best practices. |
| 49 | +- Keep PRs concise and focused on a single feature or fix. |
| 50 | +- Stay engaged in the discussions and suggest improvements. |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +Thank you for being a valuable part of our community! 🎉 |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +<a href="https://discord.gg/X69MUr2DKm" title="Discord server invite link"><img src="https://freelogopng.com/images/all_img/1691730767discord-logo-transparent.png" width="300"></a> |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
0 commit comments