Skip to content

Guidelines for Bounty Program

Jump to bottom
Neeraj edited this page Sep 30, 2024 · 2 revisions

Hyperswitch Bounty Program Guidelines

Overview

The Hyperswitch Bounty Program aims to reward contributors who help improve the project by solving issues that are marked with a bounty. We encourage developers from all backgrounds to participate and collaborate with us in making Hyperswitch a more robust and scalable solution.

This document outlines the rules, processes, and expectations around participating in our bounty program.

Bounty Participation Guidelines

  1. Eligibility:

    • The bounty program is open to all contributors, irrespective of location or experience level.

    • You must have a GitHub account to participate.

    • Any individual or team of developers can claim and work on the bounty issues.

  2. Issue Classification:

    • Bounty Issues: Issues with a bounty attached will be clearly labeled with the tag bounty and an associated amount.

    • Each bounty issue will have a detailed description, expected deliverables, and acceptance criteria.

  3. How to Claim a Bounty:

    • Before starting work, comment on the issue to express your intent to work on it. Include a proposal on how you would approach this problem and your estimated timeline.

    • Wait for a maintainer or repository owner to approve your claim by assigning the issue to you.

    • Once approved, you may start working on the issue.

    • You can only claim one bounty issue at a time. Once you complete and submit the pull request (PR), you may claim another bounty.

  4. Development Standards:

    • Follow the coding guidelines provided in the repository documentation.
    • Adhere to best practices regarding documentation and unit tests.
    • Maintain clean, readable, and well-commented code.
    • Ensure compatibility with the latest version of Hyperswitch.

Plugin Development Program

For contributors working on Plugin Development as part of the bounty program, additional requirements apply:

  1. Complete Plugin Repository:

    • The contributor is expected to develop the entire plugin repository from scratch, ensuring that it adheres to the project’s standards.
    • This includes all core files, documentation, and setup guides required for users to easily install and use the plugin.

  2. Licensing:

    • The plugin must include all relevant licenses ( MIT or Apache 2.0) to ensure legal compliance.
    • Contributors are responsible for ensuring that any third-party libraries used are compatible with the plugin’s license.

  3. Functionality Requirements:

    • The plugin must support all basic functionalities as outlined in the Plugin Development issue description.
    • The plugin should be thoroughly tested for compatibility with Hyperswitch.

  4. Demo & Documentation:

    • After the plugin development is completed, the contributor must provide a working demo of the plugin.
    • The demo should clearly show the plugin’s functionality and how it integrates with Hyperswitch.
    • Provide detailed documentation explaining how to install, configure, and use the plugin.

  5. Acceptance Criteria:

    • The plugin will be reviewed based on code quality, functionality, and ease of use.
    • It must pass all tests and be reviewed for completeness before being accepted and merged.
    • Once accepted, the contributor will be eligible for the bounty payout.

Submission Process:

  • Once you’ve completed the task, submit a pull request (PR) or Share the Repo linking to the bounty issue.
  • Ensure the PR passes all automated tests (CI/CD pipelines, if any) before marking it for review.
  • Clearly describe the work done in the PR description, referencing the issue and detailing how you have met the acceptance criteria.
  • After submission, the maintainers will review the PR. They may request changes or enhancements, so ensure your availability to address feedback.

Note: If there is any change in the Submission Process, the same will be communicated over the Community Channels, we request the contributors to be active on these channels.


Please make sure to read our Contribution Guidelines and Terms of Contest

Clone this wiki locally