Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 2.51 KB

Contributing to PlanAI

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

⚠️ Important First Step: Install Pre-commit Hook

Before you start contributing, please install the pre-commit hook by running:

pre-commit install

This is required to ensure code quality and maintain consistent formatting across all contributions.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • 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

  • Open a new issue with a clear title and detailed description of the suggested enhancement.
  • Provide any relevant examples or use cases that support your suggestion.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

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

  • Follow PEP 8.
  • Use type hints where possible.
  • Write docstrings for all public modules, functions, classes, and methods.

Documentation Styleguide

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 that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Thank you for contributing to PlanAI!