Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 4.44 KB

CONTRIBUTING.md

File metadata and controls

80 lines (60 loc) · 4.44 KB
Raw

Contributing

Thank you for considering contributing to Pactus blockchain! Please read these guidelines before submitting a pull request or opening an issue.

Code Guidelines

We strive to maintain clean, readable, and maintainable code in Pactus blockchain. Please follow these guidelines when contributing code to the project:

  • Code should follow the Effective Go guidelines.
  • Documentation should follow the Go Doc Comments format.
  • Follow the principles of clean code as outlined in Robert C. Martin's "Clean Code" book. Here you can find a summary of the book.
  • Write tests for new code or changes to existing code, and make sure all tests pass before submitting a pull request.
  • Error strings and log messages should not be capitalized (unless beginning with proper nouns or acronyms) and SHOULD NOT end with punctuation. Examples:
    • Correct ✅: "unable to connect to server"
    • Incorrect ❌: "Unable to connect to server"
    • Incorrect ❌: "unable to connect to server."

The following commands are available in the Makefile:

  • make build compiles the code into executable binaries.
  • make devtools installs required development tools.
  • make fmt formats the code according to the Go standards.
  • make check runs various checks on the code, including formatting and linting.
  • make test performs all the tests including unit tests and system tests.
  • make uint_test performs only unit tests.
  • make proto generates protobuf files, if you have made any changes to the proto buffer files.

CLI Guidelines

The help messages for CLI flags should follow this pattern:

  • Start all messages with a lowercase letter.
  • Avoid stating defaults in the help string, as Cobra automatically adds them.
  • Include a range for flags that accept a range of values.

Commit Guidelines

Please follow these guidelines when committing changes to Pactus blockchain:

  • Each commit should represent a single, atomic change to the codebase. Avoid making multiple unrelated changes in a single commit.
  • Commit message should not be longer than 50 characters.
  • Commit message should start with lowercase and not ends with punctuation.
  • Write commit message in the imperative: "fix bug" and not "fixed bug" or "fixes bug".
  • Use the Conventional Commits format for commit messages and Pull Request titles.

List of conventional commit types:

Types Description
fix A big fix
feat A new feature
docs Documentation only changes
test Adding missing tests or correcting existing tests
build Changes that affect the build system or external dependencies
ci Changes to our CI configuration files and scripts
perf A code change that improves performance
refactor A code change that neither fixes a bug nor adds a feature
style Changes that do not affect the meaning of the code (white-space, formatting, etc)
chore Other changes that don't modify src or test files

Example fo commit messages

  • Correct ✅: "feat(gRPC): sign transaction using wallet client"
  • Incorrect ❌: 'feat(gRPC): Sign transaction using wallet client."
  • Incorrect ❌: 'feat(gRPC): signed transaction using wallet client"
  • Incorrect ❌: 'sign transaction using wallet client"

Code of Conduct

This project has adapted the Contributor Covenant, version 2.1 to ensure that our community is welcoming and inclusive for all. Please read it before contributing to the project.

Thank you for your contributions to Pactus blockchain!