Contributing to BestoNet

November 16, 2024 ยท View on GitHub

First off, thank you for considering contributing to BestoNet!

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure your code follows the existing coding style.
  4. Write clear, descriptive commit messages.
  5. Include appropriate documentation updates.

Coding Guidelines

  • Use clear, descriptive variable and function names
  • Comment complex algorithms and business logic
  • Follow C# coding conventions
  • Keep methods focused and concise
  • Write XML documentation for public APIs

Documentation

  • Update the README.md if needed
  • Add XML documentation to new public methods
  • Update API documentation for interface changes
  • Include examples for new features

Thank you for your contribution!