Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.22 KB
Raw

Contributing to Raft

Thank you for considering contributing to raft - all contributions are greatly appreciated.

Getting Started

  • Make sure you have a GitHub account.
  • Fork this repository on GitHub.
  • Thoroughly read the documentation for raft and understand how the Raft consensus protocol works. At minimum, you should read the raft paper.

Pull Requests

  1. Create a new branch, named for the feature or bug you're addressing.
  2. Make your changes in the new branch.
  3. Test your changes and ensure all tests pass.
  4. Commit your changes. Use clear, concise commit messages.
  5. Push your changes to your fork on GitHub.
  6. Submit a pull request to the main repository.

Issues

  • Check the issue tracker to see if the bug or enhancement you're interested in has been reported.
  • If the issue does not exist, create a new issue. Be sure to clearly describe the issue, including steps to reproduce when it's a bug.

Code Style

  • Ensure your code follows the style of the existing codebase.
  • Add comments to your code where necessary.

License

By contributing your code, you agree to license your contribution under the terms of the MIT licence.