1
0
Fork 0
mirror of synced 2024-06-01 18:39:57 +12:00

Made requested changes

This commit is contained in:
haimantika mitra 2023-10-09 22:47:02 +05:30 committed by GitHub
parent 16d76c2e87
commit d43e4f20aa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

54
HACKTOBERFEST.md Normal file
View file

@ -0,0 +1,54 @@
# Appwrite hacktoberfest contribution
Welcome to the Appwrite Hacktoberfest contribution! We appreciate your interest in contributing to our open-source project. Please read this carefully to understand how to get started and make your contributions count.
## Familiarize with the project
- 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`. 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.
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.
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.
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 TYPE-ISSUE_ID-DESCRIPTION
```
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!