Skip to content

Latest commit

 

History

History
137 lines (97 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

137 lines (97 loc) · 4.51 KB

<<<<<<< HEAD

Contributing to JARVIS-MARK5

We're excited that you're interested in contributing to JARVIS-MARK5! This document provides guidelines for contributing to the project. Please take a moment to review this information before submitting a pull request.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/JARVIS-MARK5.git
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes, ensuring you follow the coding standards and guidelines.
  5. Commit your changes with clear, descriptive commit messages.
  6. Push your branch to your fork on GitHub: 
    git push origin feature/your-feature-name
  7. Open a pull request against the main repository's main branch.

Coding Standards

  • Follow PEP 8 style guide for Python code.
  • Use meaningful variable and function names.
  • Write clear comments and docstrings.
  • Ensure your code is compatible with Python 3.7+.

Testing

  • Add unit tests for new functionality.
  • Ensure all tests pass before submitting a pull request.
  • Run tests using pytest in the project root directory.

Documentation

  • Update the README.md file if you're adding new features or changing existing functionality.
  • Provide clear and concise documentation for new code.

Submitting Pull Requests

  • Provide a clear description of the problem and solution in your PR description.
  • Reference any related issues in your PR description.
  • Ensure your PR passes all CI checks.

Reporting Bugs

  • Use the GitHub issue tracker to report bugs.
  • Describe the bug in detail, including steps to reproduce.
  • Include information about your environment (OS, Python version, etc.).

Feature Requests

  • Use the GitHub issue tracker to suggest new features.
  • Clearly describe the feature and its potential benefits.

Questions?

If you have any questions about contributing, please open an issue or contact the project maintainers.

Thank you for contributing to JARVIS-MARK5!

Contributing to JARVIS-MARK5

We're excited that you're interested in contributing to JARVIS-MARK5! This document provides guidelines for contributing to the project. Please take a moment to review this information before submitting a pull request.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/Likhithsai2580/JARVIS-MARK5.git
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes, ensuring you follow the coding standards and guidelines.
  5. Commit your changes with clear, descriptive commit messages.
  6. Push your branch to your fork on GitHub: 
    git push origin feature/your-feature-name
  7. Open a pull request against the main repository's main branch.

Coding Standards

  • Follow PEP 8 style guide for Python code.
  • Use meaningful variable and function names.
  • Write clear comments and docstrings.
  • Ensure your code is compatible with Python 3.7+.

Testing

  • Add unit tests for new functionality.
  • Ensure all tests pass before submitting a pull request.
  • Run tests using pytest in the project root directory.

Documentation

  • Update the README.md file if you're adding new features or changing existing functionality.
  • Provide clear and concise documentation for new code.

Submitting Pull Requests

  • Provide a clear description of the problem and solution in your PR description.
  • Reference any related issues in your PR description.
  • Ensure your PR passes all CI checks.

Reporting Bugs

  • Use the GitHub issue tracker to report bugs.
  • Describe the bug in detail, including steps to reproduce.
  • Include information about your environment (OS, Python version, etc.).

Feature Requests

  • Use the GitHub issue tracker to suggest new features.
  • Clearly describe the feature and its potential benefits.

Questions?

If you have any questions about contributing, please open an issue or contact the project maintainers.

Thank you for contributing to JARVIS-MARK5!

9970a2a5c0b74385f01ab9c2347d77768b133f49