diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md index 01cd36da13..6d31b33479 100644 --- a/HACKTOBERFEST.md +++ b/HACKTOBERFEST.md @@ -6,50 +6,50 @@ Welcome to the Appwrite Hacktoberfest contribution! We appreciate your interest - 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 +## 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. +Please ensure that you always follow our [Code of Conduct](https://github.com/appwrite/awesome-appwrite/blob/master/CODE_OF_CONDUCT.md). We aim to maintain a respectful and inclusive community. + +## Contributing guide -### 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 +## 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`. Only issues labeled with `hacktoberfest` will count as a valid contribution. +1. **Valid issues**: To make your contribution count, please look for issues labeled with `hacktoberfest`. Only issues labeled with `hacktoberfest` will count as a valid contribution. -2. **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. +2. **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. -3. **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. **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. -4. **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. **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](https://appwrite.io/discord) in the `#hacktoberfest` channel. -5. **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. **Be patient with pull request 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. -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. +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 being unassigned from the issue. -## Getting Started +## 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 + git clone https://github.com/your-username/repository-name.git ``` 3. Create a new branch for your contribution. ```bash - git checkout -b TYPE-ISSUE_ID-DESCRIPTION + git checkout -b TYPE-ISSUE_ID-DESCRIPTION ``` 4. Make your changes, commit them, and push them to your forked repository. ```bash - git commit -m "Add your commit message here" - git push origin TYPE-ISSUE_ID-DESCRIPTION + git commit -m "Add your commit message here" + git push origin TYPE-ISSUE_ID-DESCRIPTION ``` 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.