From 0cecdf2937c71a99dbf661b17ba8f53f6fb379d8 Mon Sep 17 00:00:00 2001 From: Haimantika mitra Date: Fri, 6 Oct 2023 01:40:30 +0530 Subject: [PATCH] Added Hacktoberfest Contributing Guidelines --- Hacktoberfest_Contribution_Guideline.md | 53 +++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 Hacktoberfest_Contribution_Guideline.md diff --git a/Hacktoberfest_Contribution_Guideline.md b/Hacktoberfest_Contribution_Guideline.md new file mode 100644 index 0000000000..10749da7a2 --- /dev/null +++ b/Hacktoberfest_Contribution_Guideline.md @@ -0,0 +1,53 @@ +# Appwrite Hacktoberfest Contribution + +Welcome to the Appwrite Hacktoberfest contribution! We appreciate your interest in contributing to our open-source project. Please read this README carefully to understand how to get started and make your contributions count. + +## Project Familiarization + +- Before you start contributing, it's essential to get familiarized with our project. You can do that by following the [main README](https://github.com/appwrite/appwrite/blob/main/README.md). + +## Code of Conduct + +- Please ensure that you follow our [Code of Conduct](https://github.com/appwrite/awesome-appwrite/blob/master/CODE_OF_CONDUCT.md) at all times. We aim to maintain a respectful and inclusive community. + +### Contributing Guide +Please review our [Contributing Guide](https://github.com/appwrite/appwrite/blob/main/CONTRIBUTING.md) before contributing. We strive to maintain a friendly and inclusive community for everyone. + +## Hacktoberfest Contribution Guidelines + +To participate in Hacktoberfest with Appwrite, follow these guidelines: + +1. **Valid Issues**: To make your contribution count, please look for issues labeled with `hacktoberfest`. + +2. **Label Your Pull Requests**: Appwrite does not have the `hacktoberfest` label in our repositories, but we use it on specific issues. For your pull request to be valid, our team will review and add the `hacktoberfest-accepted` label once it meets the criteria. + +3. **Discuss New Issues**: If you're interested in finding and adding new issues for Hacktoberfest, please discuss it with the team on our Discord server: [appwrite.io/discord](https://appwrite.io/discord) in the `#hacktoberfest` channel. + +4. **Be Patient with PR Reviews**: PR reviews may take up to 15 days due to the volume of contributions. However, we also host PR review parties every week where you can add your PRs for instant review. + +5. **Wait for Issue Assignment**: After you have identified an issue to work on, please wait for it to be assigned to you by our team. We assign issues on a first-come, first-serve basis. + +6. **Regular Updates**: If you've been assigned an issue, it's essential to share updates every 3 days. Failure to do so may result in the unassignment of the issue. + +## Getting Started + +1. Fork the Appwrite repository you'd like to contribute to. + +2. Clone your forked repository to your local machine. + + ```bash + git clone https://github.com/your-username/repository-name.git + ``` +3. Create a new branch for your contribution. +```bash + git checkout -b feature/your-feature +``` +4. Make your changes, commit them, and push to your forked repository. + +```bash + git commit -m "Add your commit message here" + git push origin feature/your-feature + ``` +5. Create a Pull Request (PR) from your forked repository to the Appwrite repository. Be sure to reference the issue you are addressing in your PR description. + +Thank you for contributing to Appwrite, and we look forward to your Hacktoberfest contributions! If you have any questions or need assistance, feel free to ask on our Discord server or in the issue discussion. Happy hacking!