Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 2.29 KB

Contributing to BitLDC Protocol

Thank you for your interest in contributing to the BitLDC Protocol! This project is dedicated to developing a comprehensive design and high-level examples for the innovative BitLDC system. We value contributions that enhance the clarity, depth, and accuracy of our documentation and examples.

How to Contribute

Contributions can be made in various forms, such as improving design documents, proposing new high-level implementation ideas, and enhancing existing examples. We welcome insights and suggestions from all community members.

Improving Documentation

If you have suggestions for improving the design documentation:

  1. Check the existing documents to see if your suggestion has already been included or discussed.
  2. Open a new issue on GitHub to discuss your suggestion.
  3. For minor changes, feel free to submit a pull request directly.

Proposing New High-Level Examples

To propose a new high-level example or a concept:

  1. Open a new issue and tag it as an enhancement or a new example.
  2. Clearly describe your idea, including how it fits into the existing framework and its potential benefits.

Pull Requests for Documentation and Examples

When submitting a pull request:

  1. Include a clear and detailed description of your changes.
  2. If applicable, reference any related issues.
  3. Ensure that your contributions are well-structured and easy to understand.

Guidelines for Contributions

  • Clarity and Accuracy: Ensure that your contributions are clear, accurate, and easy to understand. Avoid technical jargon where possible.
  • Consistency: Follow the formatting and style of the existing documents. Consistency helps in maintaining readability.
  • References: If your contribution is based on external sources, please provide proper references or links.

Review Process

Contributions will be reviewed by the project maintainers. We aim to review and respond to pull requests and issues promptly. Feedback or requests for changes to contributions will be communicated through the GitHub interface.

Questions and Discussions

If you have questions or wish to discuss ideas before making a contribution, feel free to open a discussion on our GitHub Discussions page. This platform is a great place for brainstorming and collaborative idea development.