Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
145 lines (105 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

145 lines (105 loc) · 4.49 KB

Contributing to KindMesh

Thank you for your interest in contributing to KindMesh! This document provides guidelines and instructions for contributing to the project.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the KindMesh Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up the development environment as described in the README.md
  4. Create a new branch for your contribution

How to Contribute

Reporting Bugs

Before submitting a bug report:

  1. Check the issue tracker to see if the issue has already been reported
  2. Update your software to the latest version to see if the issue persists

When submitting a bug report:

  1. Use the bug report template if available
  2. Include detailed steps to reproduce the bug
  3. Describe the expected behavior and what actually happened
  4. Include screenshots, logs, or other relevant information
  5. Specify the version of KindMesh you're using

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When suggesting an enhancement:

  1. Use the feature request template if available
  2. Provide a clear and detailed explanation of the feature
  3. Explain why this enhancement would be useful to most KindMesh users
  4. List possible implementation details if you have them

Code Contributions

  1. Look for issues labeled "good first issue" or "help wanted"
  2. Comment on the issue to let others know you're working on it
  3. Follow the Development Workflow
  4. Submit a pull request with your changes

Development Workflow

Setting Up the Development Environment

  1. Install the required dependencies:

    ./local_setup.sh

  2. Start the application in development mode:

    ./local_start.sh

  3. Make your changes to the codebase

Coding Standards

  • Follow PEP 8 for Python code style
  • Use type hints for all function parameters and return values
  • Write docstrings for all functions, classes, and modules
  • Keep functions small and focused on a single responsibility
  • Use meaningful variable and function names

Testing

  • Write unit tests for all new functionality

  • Ensure all tests pass before submitting a pull request:

    python -m unittest discover tests/unit
python -m unittest discover tests/integration

  • Aim for high test coverage of your code

Documentation

  • Update the documentation to reflect your changes
  • Document new features, options, or behavior changes
  • Include examples where appropriate
  • Update the CHANGELOG.md file with your changes

Pull Request Process

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

    or

    git checkout -b fix/your-bugfix-name

  2. Make your changes and commit them with clear, descriptive commit messages:

    git commit -m "Add feature: description of your feature"

  3. Push your branch to your fork:

    git push origin feature/your-feature-name

  4. Submit a pull request to the main repository

    • Fill out the pull request template completely
    • Reference any related issues
    • Describe your changes in detail

  5. Address any feedback from code reviews

    • Make requested changes
    • Push additional commits to your branch

  6. Once approved, your pull request will be merged by a maintainer

Community

  • Join our community discussions on GitHub Discussions
  • Follow the project on social media for updates
  • Participate in community events and meetings

Thank you for contributing to KindMesh! Your time and expertise help make this project better for everyone.