Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (63 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

87 lines (63 loc) · 3.13 KB

Contributing to JarvisAI

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

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to:

  • Use welcoming and inclusive language.
  • Be respectful of differing viewpoints and experiences.
  • Gracefully accept constructive criticism.
  • Focus on what is best for the community.
  • Show empathy towards other community members.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for JarvisAI. 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.
  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for JarvisAI, 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.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests

The process described here has several goals:

  1. Maintain JarvisAI's quality.
  2. Fix problems that are important to users.
  3. Engage the technical community in working toward the best possible JarvisAI.

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

  1. Follow all instructions in the template.
  2. Follow the style guides.
  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

  • Follow PEP 8.
  • Use black for code formatting.
  • Use isort for import sorting.
  • Use mypy for type checking.

Setting Up Development Environment

  1. Clone the repository:

    git clone https://github.com/your-username/JarvisAI.git
cd JarvisAI

  2. Create a virtual environment:

    python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

  3. Install dependencies:

    pip install -r requirements.txt

  4. Run the application:

    python main.py

Thank you for your contributions!