Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.84 KB

Contributing to Jarvis AI

First off, thank you for considering contributing to Jarvis AI! We appreciate your time and effort in helping improve the project.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue in the GitHub repository. Before you do, please check the existing issues to see if it has already been reported. When opening a new issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant logs or screenshots.
  • Your environment (e.g., operating system, Node.js version, etc.).

Suggesting Enhancements

We welcome suggestions for new features or enhancements. To suggest an enhancement, please open an issue with:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any related code or pseudocode, if applicable.

Pull Requests

If you want to make a change to the code, you can submit a pull request (PR). Please follow these steps:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes (git checkout -b feature-branch).
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository (git push origin feature-branch).
  6. Open a pull request to the main branch of the original repository.

In your pull request, please include:

  • A clear and descriptive title.
  • A detailed description of what you have changed and why.
  • Any relevant issue numbers (e.g., Closes #123).

Code Style

Please ensure your code adheres to the following standards:

  • Use two spaces for indentation.
  • Follow the existing code style and conventions.
  • Write clear and concise comments where necessary.

Testing

Before submitting a pull request, please make sure your changes are well-tested.