From a0d04e1a21ee81afa9195fcb6df764015b9c18e9 Mon Sep 17 00:00:00 2001 From: NipuniBhagya Date: Fri, 4 Oct 2024 16:29:29 +0530 Subject: [PATCH] Add developer guidelines for Hacktoberfest 2024 --- HACKTOBERFEST.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 HACKTOBERFEST.md diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md new file mode 100644 index 0000000..8884edb --- /dev/null +++ b/HACKTOBERFEST.md @@ -0,0 +1,73 @@ +# ๐ŸŽ‰ Hacktoberfest 2024 - Contribute to Asgardeo React SDK ๐ŸŽ‰ + +The Asgardeo React SDK is part of the **Hacktoberfest 2024** program! You can check out the details on how to contribute and the rewards available for participants. Join the event, make valuable contributions, and earn exciting rewards while enhancing your skills in building secure React applications with Asgardeo. + +For every successful code contribution submitted as accepted you are rewarded with: + +๐Ÿ’ฐ Amazon vouchers based on the complexity of the issue + +- **$25 Amazon voucher**: Issues marked as `good first issue` +- **$50 Amazon voucher**: For other issues +- **WSO2 Practitioner/Developer certification vouchers** +- **$1,000 Asgardeo credits**: Valid for 12 months + +> ๐Ÿ’ก *Pro Tip*: Check out the list of issues included in Hacktoberfest 2024 [here](https://github.com/asgardeo/asgardeo-auth-react-sdk/issues?q=is%3Aissue+is%3Aopen+label%3AHacktoberfest). + + +## ๐Ÿš€ How to Contribute to Asgardeo React SDK + +We welcome contributions in various formsโ€”be it **bug fixes**, **new features**, or **documentation improvements**. Hereโ€™s how to get started: + +### ๐Ÿ› ๏ธ Step-by-Step Contribution Guide + +1. **Fork the Repository** + +Start by forking the repository and cloning it locally: + +```bash +git clone https://github.com/your-username/asgardeo-auth-react-sdk.git +cd asgardeo-auth-react-sdk +``` + +2. **Create a Branch** + +It's recommended to create a new branch for each feature or bug fix you work on: + +```bash +git checkout -b feature-name +``` + +3. **Write Meaningful Commits** + +Commit messages should be clear and descriptive. + +```bash +Ex: Add support for custom params in the token request +``` + +4. **Open a Pull Request** + +After committing your changes, push the branch to your fork and open a pull request (PR) to the main repository. Make sure to: + +- Provide a clear description of the issue or feature. +- Reference any relevant issue numbers. +- Request a review from one of the maintainers. + +5. **Getting Started** + +We encourage you to dive into the project and familiarize yourself with the existing codebase and issues before contributing. You can get started by: + +- Explore Issues: Check the Issues page for tasks labeled with `Hacktoberfest` or `good first issue`. +- Check the Documentation: Review the project's documentation to understand the current features and architecture. + + ### ๐Ÿ”Ž **Need Help?** + +If you need any assistance or have questions, feel free to reach out by: + +- Commenting on the issue you're working on. +- Starting a discussion in the repository. + + +Together, letโ€™s make Hacktoberfest 2024 a memorable one! ๐Ÿš€ + +Happy coding! ๐Ÿ’ปโœจ \ No newline at end of file