Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (55 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

87 lines (55 loc) · 3.8 KB

Contributing to API Client Generator

First off, thank you for considering contributing to API Client Generator! It's people like you that make API Client Generator such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for API Client Generator. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for API Client Generator, including completely new features and minor improvements to existing functionality.

  • 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 many details as possible.
  • Provide specific examples to demonstrate the steps or point out the part of API Client Generator where the suggestion is related to.
  • Explain why this enhancement would be useful to most API Client Generator users.

Your First Code Contribution

Unsure where to begin contributing to API Client Generator? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain API Client Generator's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible API Client Generator
  • Enable a sustainable system for API Client Generator's maintainers to review contributions

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

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

All Python code must adhere to the PEP 8 style guide.

Additionally:

  • Use Black for code formatting
  • Use isort for import sorting

Documentation Styleguide

  • Use Markdown for documentation.
  • Reference function and variable names using backticks: like_this.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues for bugs in the codebase
  • enhancement - Issues for new features or improvements
  • documentation - Issues related to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested

Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.