Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.64 KB

File metadata and controls

39 lines (28 loc) · 1.64 KB

Contributing to txio

First off, thank you for considering contributing to txio! It's people like you that make txio such a great tool for the multi-chain blockchain ecosystem.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • 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

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • 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.
  • Explain why this enhancement would be useful to most txio users.

Pull Requests

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Do not include issue numbers in the PR title.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Before merging, automated checks must pass:
    • Tests
    • Linting
    • Build
  • End all files with a newline.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line