Skip to main content

Contribution

Thank you for your interest in contributing to SwiftPay! While this is primarily a solo project, we happily welcome contributions from the community. This document provides guidelines and steps for contributing.

🎯 Types of Contributions We're Looking For​

  • Bug fixes
  • Documentation improvements
  • Code optimization
  • New features aligned with the project roadmap
  • Test cases
  • Typo corrections
  • Translation help

🚀 Getting Started​

  1. Fork the Repository

    # Clone your fork
    git clone https://github.com/nb3n/swiftpay-docs
    cd swiftpay-docs

    # Add upstream remote
    git remote add upstream https://github.com/original/swiftpay-docs.git

  2. Create a Branch

    # Create a new branch for your feature
    git checkout -b feature/your-feature-name
    # or
    git checkout -b fix/your-bug-fix

📝 Development Process​

  1. Setup Development Environment

    # Install dependencies
    npm install   # or yarn install

    # Run tests
    npm test      # or yarn test

    # Start development server
    npm run dev   # or yarn dev

  2. Make Your Changes

    • Write clean, maintainable code
    • Follow existing code style
    • Add comments where necessary
    • Update documentation if needed

  3. Test Your Changes

    • Add/update tests for new features
    • Ensure all tests pass
    • Test across different environments if applicable

📤 Submitting Changes​

  1. Commit Your Changes

    git add .
    git commit -m "Brief description of your changes"

  2. Pull Request Guidelines

    • Use a clear, descriptive title
    • Include relevant issue numbers if applicable
    • Provide detailed description of changes
    • Add screenshots for UI changes

💻 Commit Message Format​

type(scope): Brief description

Detailed description if needed

Fixes #issue_number

Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Adding/updating tests
  • chore: Maintenance tasks

🔍 Code Review Process​

  1. Maintainer will review your PR within 3-5 business days
  2. Changes may be requested
  3. Once approved, PR will be merged

❗ Important Notes​

  • This is a solo project but community contributions are valued
  • Major changes should be discussed via issue first
  • Follow the code of conduct
  • Be patient with the review process
  • Quality over quantity

📞 Questions?​

📜 License​

By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE file).

Thank you for contributing to SwiftPay! Your efforts help make this payment gateway better for everyone. 🙏