Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (60 loc) · 4.99 KB

CONTRIBUTING.md

File metadata and controls

96 lines (60 loc) · 4.99 KB

# Contributing to python-privatbank-client Library

First off, thank you for considering contributing to python-privatbank-client 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-privatbank-client Library Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@example.com.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for python-privatbank-client 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-privatbank-client 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-privatbank-client 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. Ensure the test suite passes by running pytest.
  4. Make sure your code lints and adheres to the PEP 8 style guide.
  5. Submit a pull request through GitHub.

What Happens Next?

Once you submit a pull request:

  1. Your pull request will be reviewed by a maintainer.
  2. You will be notified if further changes are required.
  3. If accepted, your code will be merged into the repository as a part of the next release.

Make sure to follow up on comments left by reviewers promptly to ensure the process goes smoothly.

Code Style

  • Follow the PEP 8 style guide.
  • Ensure that the code passes all linting checks (e.g., using flake8 or similar tools).

Tests

  • Use pytest for testing.
  • Ensure all tests pass locally before submitting a pull request.
  • Add tests for new functionality or edge cases you are addressing.

Licensing

By contributing to python-privatbank-client Library, you agree that your contributions will be licensed under the MIT License. If your files require a license header, include the agreed-upon MIT header in those files.Contributing to python-privatbank-client Library