-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Hacktoberfest Contribution Rules
-
First, make sure you’ve signed up for Hacktoberfest to be eligible for the event.
-
Check out the Hyperswitch repository on GitHub. Ensure you “Star” and “Like” the repo so you can find the issues easily.
-
Hyperswitch requires you to submit at least 1 accepted pull request between October 1st and October 31st to qualify for rewards.
-
If you submit more than 3 accepted pull requests between October 1st and October 31st, you'll qualify for Premium rewards.
-
Explore the Repository:
-
Look through the repository and check the Issues section to find issues marked as hacktoberfest, good first issue, or help wanted.
-
Read the project’s README, Contribution Gudielines and ensure you understand the project structure before you start contributing.
-
If you are attempting to Paid contributions, we request you to go through Terms & Conditions before you start to work on the projects.
-
-
One Issue at a Time: Contributors are only allowed to work on one issue at a time. Once your pull request (PR) for an issue has been successfully merged or closed, you can select another issue to work on.
-
Please comment on the issue you want to work on so maintainers know that it’s being handled. We will assign the issue to you once we confirm your request.
-
Pull Request Guidelines:
-
Follow Coding Standards: Please ensure that your code follows the project's coding style and guidelines. Always run any necessary tests or linters before submitting a PR.
-
Branch Naming: Always create a new branch for your contributions. Use meaningful names like fix/issue-<issue-number> or feature/issue-<issue-number>.
-
Descriptive Commits: Use clear, concise, and meaningful commit messages.
-
PR Title and Description: Ensure the title of your pull request clearly describes the issue you're solving. In the PR description, link to the relevant issue number (e.g., "Fixes #123"). Else, the PR will not be reviewed.
-
No Multiple Changes: Each PR should address only one issue or change. Please avoid combining multiple feature changes or fixes into a single pull request.
-
-
Review Process:
-
Once your PR is submitted, a project maintainer will review it. The reviewer may suggest changes, so be prepared to address feedback.
-
Please be patient while maintainers review your PR, especially during the busy Hacktoberfest period. We’ll try to get back to you as soon as possible.
-
After your PR is merged, you can select another issue to work on.
-
-
Testing:
- Ensure your code passes all tests. If the project has automated tests, make sure they are passing before submitting your PR. If there are no tests in place, and you’re adding new functionality, consider writing tests for your code.
-
Respect and Collaboration:
-
Be respectful when communicating with maintainers and other contributors. We are all here to collaborate, learn, and grow!
-
If you encounter any issues or need clarification, feel free to ask questions in the issue thread or discussions or community channel - be descriptive as possible
-
-
Technical Support & Issue Guidelines:
-
Need Help? Just ping us on Discord or Slack with the issue link and your doubt. We’re here for you!
-
Give Us a Heads-Up: Can’t continue? Let us know so we can reassign it smoothly.
-
Friendly Check-in: We’ll send a reminder after 3-4 days. No response in 2 days? We’ll pass it on to the next person. Your updates keep things running smoothly!
-
- 1 Issue Completed: Contributors who submit and get 1 PR merged will receive a Hyperswitch t-shirt from our team.
- 3+ Issues Completed: Contributors with more than 3 merged PRs will be rewarded with an exclusive Hyperswitch Swag kit.
-
Documentation Contributions: If you notice any issues with our documentation, feel free to submit PRs to improve it.
-
No-Code Contributions: No-code contributions (e.g., design, documentation, writing blogs) are also welcome and count towards Hacktoberfest. Happy contributing and good luck! 🎉