Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (48 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 1.46 KB
Raw

Contributing to warpSpeed Integrations

Thank you for helping build open-source integrations for warpSpeed OPEN.

Before you start

Please read the bounty issue carefully and confirm that you understand:

  • The integration objective
  • The API or platform involved
  • Required environment variables
  • Acceptance criteria
  • Testing requirements
  • Documentation requirements

Claiming a bounty

  1. Sign up on the warpSpeed OPEN website.
  2. Open the GitHub issue linked to the bounty.
  3. Comment: I would like to work on this integration bounty.
  4. Wait for a maintainer to confirm.
  5. Start only after confirmation.

Branch naming

Use a clear branch name:

integration/google-calendar-connector
integration/slack-notifications
docs/gmail-setup-guide
fix/webhook-validation

Pull request rules

Your PR should include:

  • Clear explanation of what you built
  • Setup instructions
  • Environment variables needed
  • Example usage
  • Tests or manual test steps
  • Screenshots or logs if useful

Code quality expectations

  • Keep code simple and readable.
  • Do not hardcode secrets or API keys.
  • Use environment variables for credentials.
  • Add comments where logic is not obvious.
  • Update documentation when behavior changes.

Security rules

Never commit:

  • API keys
  • OAuth secrets
  • Access tokens
  • Private certificates
  • Production credentials
  • User data

Payment rule

Paid bounty work is rewarded after the pull request is reviewed, approved, and merged.