Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (43 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.21 KB

Contributing to DIY Thread Border Router

Thank you for your interest in contributing to the DIY Thread Border Router project! This document provides guidelines and instructions for contributing.

Code of Conduct

Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request:

  1. Check if the issue already exists in the issue tracker
  2. If not, create a new issue with a descriptive title and detailed description
  3. Include steps to reproduce the issue, expected behavior, and actual behavior
  4. Include system information (hardware, OS version, etc.)

Submitting Changes

To contribute code or documentation changes:

  1. Fork the repository
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test your changes thoroughly
  5. Commit with clear, descriptive messages: git commit -m "Add feature: your feature description"
  6. Push to your fork: git push origin feature/your-feature-name
  7. Create a pull request against the main repository

Pull Request Process

  1. Ensure your code follows the project's style and conventions
  2. Update documentation as necessary
  3. Include test cases if applicable
  4. Ensure all automated tests pass
  5. A maintainer will review your pull request and provide feedback

Development Setup

Follow the instructions in the Setup Guide to set up your development environment.

Testing

Before submitting changes, please test your changes thoroughly:

  1. Test on actual hardware if possible
  2. Verify all features continue to work
  3. Check for any regressions

Documentation Guidelines

When updating documentation:

  • Use clear, concise language
  • Include examples where appropriate
  • Check for spelling and grammar errors
  • Ensure all links work correctly
  • Follow Markdown best practices

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to the DIY Thread Border Router project!