Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

67 lines (50 loc) · 3.97 KB

Contributing to MrBoB Agent Tools

Thank you for considering contributing to MrBoB Agent Tools! We welcome contributions from the community to help improve the project. Please follow the guidelines below to ensure a smooth and effective contribution process.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Coding Standards
  4. Pull Request Guidelines
  5. Issue Reporting

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it to understand the standards of behavior we expect from our community.

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
  2. Clone the repository: Clone your forked repository to your local machine using the following command: 
    git clone https://github.com/your-username/MrBoB-Agent-Tools.git
cd MrBoB-Agent-Tools
  3. Create a branch: Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make changes: Make your changes to the codebase. Ensure that your code follows the Coding Standards and includes appropriate tests.
  5. Commit your changes: Commit your changes with a descriptive commit message: 
    git commit -m "Add feature: your feature description"
  6. Push to your fork: Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  7. Create a pull request: Open a pull request from your forked repository to the main repository. Provide a clear and detailed description of your changes.

Coding Standards

To maintain a consistent codebase, please adhere to the following coding standards:

  • PEP 8: Follow the PEP 8 style guide for Python code.
  • Docstrings: Use Google style docstrings for documenting functions, classes, and modules.
  • Type Annotations: Use type annotations to specify the expected types of function arguments and return values.
  • Testing: Write unit tests for new features and bug fixes. Ensure that all tests pass before submitting a pull request.

Pull Request Guidelines

To ensure a smooth review process, please follow these guidelines when submitting a pull request:

  1. Provide a clear description: Clearly describe the purpose and scope of your changes. Include any relevant issue numbers.
  2. Keep changes focused: Make sure your pull request is focused on a single feature or bug fix. Avoid combining multiple unrelated changes in a single pull request.
  3. Include tests: Ensure that your changes are covered by unit tests. If applicable, include integration tests as well.
  4. Update documentation: If your changes affect the public API or user-facing features, update the relevant documentation.
  5. Follow coding standards: Ensure that your code adheres to the Coding Standards mentioned above.

Issue Reporting

If you encounter a bug or have a feature request, please follow these steps to report an issue:

  1. Search for existing issues: Before creating a new issue, search the existing issues to see if your problem or request has already been reported.
  2. Create a new issue: If you don't find a matching issue, create a new issue using the appropriate issue template. Provide as much detail as possible, including steps to reproduce the problem, expected behavior, and any relevant screenshots or logs.
  3. Be respectful: When reporting issues, please be respectful and considerate. Remember that contributors are volunteers who are dedicating their time to improve the project.

Thank you for contributing to MrBoB Agent Tools! Your contributions are greatly appreciated.