Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

63 lines (49 loc) · 2.21 KB

Contributing to RazorpayKit

First off, thanks for taking the time to contribute! 🎉

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include code samples and stack traces if applicable

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed functionality
  • Explain why this enhancement would be useful
  • List any alternative solutions or features you've considered

Pull Requests

  • Fill in the required template
  • Follow the Swift style guide
  • Include appropriate test coverage
  • Update documentation for significant changes
  • Follow the commit message guidelines

Commit Message Guidelines

We follow conventional commits for semantic versioning:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools

Development Process

  1. Fork the repo
  2. Create a new branch from main
  3. Make your changes
  4. Add tests if applicable
  5. Run the test suite
  6. Push your branch and submit a PR

Swift Style Guide

  • Follow Swift's official API design guidelines
  • Use SwiftLint for consistent styling
  • Maintain proper documentation for public APIs

Questions?

Feel free to open an issue or join our discussions!

Thank you for contributing to RazorpayKit! 🙏