diff --git a/README.md b/README.md index 19b173b..70a2052 100644 --- a/README.md +++ b/README.md @@ -1 +1,64 @@ -# community-website \ No newline at end of file + +# 🚀 Contribution Workflow + +Follow the steps below to contribute effectively: + +1. **Fork the Repository:** + - Navigate to the `dev` branch and fork the repository onto your personal GitHub account. + +2. **Clone the Repository:** + - Clone the forked repository to your local development environment. + ```bash + git clone https://github.com/your-username/community-website.git + ``` + +3. **Create a New Branch Locally:** + - Before making any changes, create a new branch using the required naming convention: + ```bash + git checkout -b feature/your-feature-name + ``` + **Branch Naming Schema:** `feature/your-feature-name` or `fix/your-bug-description` + +4. **Make Your Changes:** + - Add your code, features, or bug fixes. + +5. **Commit Your Changes:** + - Commit your changes locally with meaningful messages: + ```bash + git add . + git commit -m "feat: Added new feature" + ``` + +6. **Push to Your Repository:** + - Push the changes to your forked repository: + ```bash + git push origin feature/your-feature-name + ``` + +7. **Create a Pull Request (PR):** + - Go to the community repository and create a PR from your local branch to the `dev` branch. + +8. **Code Review:** + - Your PR will be reviewed by maintainers. Make necessary changes if requested. + +--- + +## 💡 Contribution Tips + +- Always follow the coding style and best practices. +- Keep PRs concise and focused on a single feature or fix. +- Stay engaged in the discussions and suggest improvements. + +--- + +Thank you for being a valuable part of our community! 🎉 + + + + + + +![SourcewareLab Logo](https://raw.githubusercontent.com/SourcewareLab/community-website/refs/heads/main/imgs/logo.png) + + +