Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
177 lines (135 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

177 lines (135 loc) · 3.46 KB
Raw

Contributing to TSP Payment Gateway

Thank you for your interest in contributing to the TSP Payment Gateway project! This document provides guidelines for contributing.

How to Contribute

1. Documentation

Help improve our documentation by:

  • Fixing typos and grammar
  • Clarifying confusing sections
  • Adding examples
  • Updating outdated information

2. Code Examples

Contribute working code examples for:

  • New payment provider integrations
  • Additional features
  • Optimization techniques
  • Security improvements

3. Knowledge Base

Expand our knowledge base with:

  • New regulatory insights
  • Technical best practices
  • Case studies
  • Lessons learned

4. Bug Reports

Report issues by:

  • Creating a GitHub issue
  • Describing the problem clearly
  • Providing steps to reproduce
  • Suggesting a solution

5. Feature Requests

Suggest improvements by:

  • Creating a GitHub issue
  • Explaining the use case
  • Describing the desired outcome
  • Providing examples

Getting Started

1. Fork the Repository

git clone https://github.com/your-username/tsp-payment-gateway-repo.git
cd tsp-payment-gateway-repo

2. Create a Branch

git checkout -b feature/your-feature-name

3. Make Your Changes

  • Follow the existing style and structure
  • Update relevant documentation
  • Add comments where needed
  • Test your changes

4. Commit Your Changes

git commit -m "Add your changes"

5. Push to Your Fork

git push origin feature/your-feature-name

6. Create a Pull Request

  • Go to the original repository
  • Click "New Pull Request"
  • Select your branch
  • Describe your changes
  • Submit the PR

Contribution Guidelines

Documentation

  • Use Markdown format
  • Follow existing structure
  • Include examples where helpful
  • Add cross-references to related documents
  • Proofread before submitting

Code

  • Follow Python PEP 8 style guide
  • Add comments for complex logic
  • Include error handling
  • Write unit tests
  • Update documentation

Commit Messages

  • Use clear, descriptive messages
  • Start with verb (Add, Fix, Update, etc.)
  • Keep messages concise
  • Reference issues when relevant

Examples:

  • "Add PayPal integration guide"
  • "Fix typo in regulatory overview"
  • "Update financial projections for 2026"

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Acknowledge contributions
  • Focus on ideas, not individuals
  • Help others learn and grow

Review Process

  1. Submission: You submit a pull request
  2. Review: Team reviews your contribution
  3. Feedback: We provide constructive feedback
  4. Revision: You make requested changes
  5. Approval: We approve and merge your PR
  6. Recognition: Your contribution is acknowledged

What We're Looking For

High Priority

  • Regulatory updates and clarifications
  • Security improvements
  • Bug fixes
  • Documentation improvements
  • Code examples for new integrations

Medium Priority

  • Performance optimizations
  • Additional features
  • Enhanced error handling
  • Better testing

Lower Priority

  • Style improvements
  • Minor documentation updates
  • Code refactoring

Questions?

  • Check existing issues and PRs
  • Review the documentation
  • Ask in a new GitHub issue
  • Contact the maintainers

Recognition

All contributors are recognized in:

  • The CONTRIBUTORS file
  • Release notes
  • Project documentation

Thank you for contributing! 🙏

Last Updated: June 2026
Version: 1.0