Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

87 lines (56 loc) · 4.35 KB

Contributing to Python-Pin-Payments Library

First off, thank you for considering contributing to Python-Pin-Payments Library! It's people like you that make this project great!

Code of Conduct

This project and everyone participating in it is governed by the Python-Pin-Payments Library Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Python-Pin-Payments Library. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • Perform a cursory search to see if the bug has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined that a bug hasn't been filed, create an issue and provide the following information by filling in the template.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots which show you following the described steps and clearly demonstrate the problem.
  • If you're reporting that the library crashed, include a crash report with a stack trace from the program.
  • If the problem is related to performance, include a CPU profile capture of the execution of the affected functions.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Python-Pin-Payments Library, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined that the enhancement hasn't been filed, create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and code snippets which demonstrate the use of the suggested enhancement.

Your First Code Contribution

  • Get started with our documentation: follow the setup instructions in the README.md file.
  • Check for open issues: start by looking through the issues.

Pull Requests

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Python-Pin-Payments Library
  • Enable a sustainable system for maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Create a branch for your contribution.
  2. Write tests for your changes.
  3. If you added code that should be tested, add tests.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Submit a pull request through the GitHub.

Code Style

  • Follow the PEP 8 style guide.
  • Ensure that the code passes all linting checks.

Tests

  • Use pytest for testing.
  • Ensure all tests pass before submitting a pull request.

Licensing

By contributing to Python-Pin-Payments Library, you agree that your contributions will be licensed under the MIT License.