Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.33 KB
Raw

Contributing to Blockchain Utilities Library

First off, thank you for considering contributing to Blockchain Utilities Library. It's people like you that make Blockchain Utilities Library such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Blockchain Utilities Library. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Explain the problem and include additional details to help maintainers reproduce the problem:
    • Use a clear and descriptive title for the issue to identify the problem.
    • Describe the exact steps which reproduce the problem in as many details as possible.
    • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Blockchain Utilities Library, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • End all files with a newline

Coding Conventions

  • We follow the standard conventions of Java/Kotlin language.
  • Ensure that your code follows the style guide of the language.
  • Ensure that all tests pass if you made changes to the code base.
  • Write meaningful and clear commit messages.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Please make sure to read and understand it fully.

Thank You!

Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.