Contributing to Shell-AI

August 20, 2023 ยท View on GitHub

Thank you for your interest in contributing to Shell-AI! Your contributions will help make this tool more robust and user-friendly. This document outlines the guidelines for contributing to this project.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please open a new issue on GitHub.

Setting Up the Development Environment

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/ricklamers/shell-ai.git
  3. Create a virtual environment: python -m venv env
  4. Activate the virtual environment: source env/bin/activate (Linux/macOS) or env\Scripts\activate (Windows)
  5. Install the dependencies: pip install -r requirements.txt

Submitting a Pull Request

  1. Create a new branch: git checkout -b feature/my-feature or git checkout -b fix/my-fix
  2. Make your changes and commit them: git commit -m "Add my feature"
  3. Push the changes to your fork: git push origin feature/my-feature or git push origin fix/my-fix
  4. Open a pull request against the main branch.

Code Style

Black, ruff, isort

Testing

Add pytest unit tests where it makes sense.

Review Process

  1. A maintainer will review your pull request and provide feedback.
  2. Once approved, your pull request will be merged.

License

By contributing to Shell-AI, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Shell-AI!