Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 3.2 KB
Raw

Contributing to PRGenius

First off, thank you for considering contributing to PRGenius! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Code of Conduct

This project and everyone participating in it is governed by the PRGenius 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 PRGenius. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use the GitHub Issues search — check if the issue has already been reported.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for PRGenius, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

  • Use the GitHub Issues search to check if the enhancement has already been suggested.
  • If you're unable to find an open issue suggesting the enhancement, open a new one. Provide a clear and detailed explanation of the feature or improvement you want to see, including any documents or links for context.

Pull Requests

The process described here has several goals:

  • Maintain PRGenius's quality
  • Fix problems that are important to users
  • Enable a sustainable system for PRGenius'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.
  • Use Black for code formatting.
  • Use Type Hints where possible.

Additional Notes

Please adhere to the GitHub Flow. If you have any questions about contributing, please feel free to contact the project maintainer.

Thank you for contributing to PRGenius!