diff --git a/Contribution Guide.md b/Contribution Guide.md new file mode 100644 index 0000000..eff1aa7 --- /dev/null +++ b/Contribution Guide.md @@ -0,0 +1,76 @@ +# Contributing to Flutter Devs Kenya 🚀 + +Welcome to the Flutter Devs Kenya community! We're excited that you're interested in contributing to our project. Your contributions play a vital role in making our community and resources better. + +## How to Contribute + +### Code Contributions + +If you're a developer, you can contribute by improving our website, app, or related projects. Here's how you can get started: + +1. Fork the repository to your own GitHub account. +2. Create a new branch with a descriptive name. +3. Make your changes and improvements. +4. Ensure your code follows our Coding Guidelines. +5. Submit a pull request to the main branch of the original repository. +6. Your pull request will be reviewed by the project maintainers. + +### Content Contributions + +We welcome contributions to our documentation, tutorials, and any other content related to Flutter development. Here's how you can contribute: + +1. Fork the repository to your own GitHub account. +2. Create a new branch with a descriptive name. +3. Make your content changes and improvements. +4. Ensure your content follows our Content Guidelines. +5. Submit a pull request to the main branch of the original repository. +6. Your pull request will be reviewed by the project maintainers. + +### Reporting Issues + +If you come across any issues, bugs, or have suggestions for improvements, please create a new issue on our GitHub repository. We appreciate your feedback! + +## Getting Started + +Before contributing, make sure you have the following: + +- A GitHub account. +- Knowledge of Flutter development (if contributing code). +- Familiarity with Markdown (if contributing documentation). + +## Coding Guidelines + +When contributing code, please adhere to the following guidelines: + +- Include appropriate comments and documentation. +- Write clear and concise commit messages. +- Test your code thoroughly. + +## Content Guidelines + +When contributing content, please consider the following: + +- Write in clear and concise language. +- Use proper grammar and spelling. +- Add code snippets, images, or examples to enhance understanding. +- Follow our documentation structure and formatting. + +## Creating a Pull Request + +To submit your contribution: + +1. Go to the original repository. +2. Click on "Pull Requests" and then "New Pull Request." +3. Select your forked repository and the branch with your changes. +4. Provide a descriptive title and details about your contribution. +5. Submit the pull request. + +## Code Review Process + +Your pull request will be reviewed by project maintainers. Feedback and discussions may occur to ensure the quality of contributions. Once approved, your changes will be merged into the main repository. + +## Contact + +If you have any questions, concerns, or need guidance, you can reach out to us through our [Telegram group](https://t.me/joinchat/bJY8P_7m5UM3YWE8). + +Thank you for contributing to Flutter Devs Kenya and being a part of our vibrant community!