Skip to content

Latest commit

 

History

History
70 lines (56 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

70 lines (56 loc) · 3.52 KB
Raw

Contributing to VechainThor

Welcome to VechainThor! We appreciate your interest in contributing. By participating in this project, you agree to abide by our Code of Conduct.

VeChain Improvement Proposals (VIPs)

Vechain Improvement Proposals (VIPs) documents protocol improvements to the VechainThor blockchain. A successful VIP represents a consensus among the Vechain community and developers, and is a standard for VechainThor implementations. The framework is designed to establish a systematic and organized approach for introducing new features into the VechainThor protocol. We encourage community members and developers to actively participate in shaping the future of Vechain by proposing and discussing innovative ideas.

Before You Propose

Before submitting a new VIP, it's crucial to ensure that your idea hasn't already been proposed or implemented. Please take the time to check the existing proposals on our GitHub repository to avoid duplication and to better understand the current development landscape.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/[your-username]/thor.git
    Note: Replace [your-username] with your actual GitHub username.
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  4. For a smooth review process, please ensure your branch is up-to-date with the master branch of the vechain/thor repository, and run the tests before committing your changes: 
    make test
    • Note: Please refer to the README for information on how to start the node and interact with the API.
  5. Make your changes and commit them with a clear and concise commit message.
  6. Push your changes to your forked repository. 
    git push origin feature/your-feature-name
    • Note: All commits must be signed with a GPG key. If you haven't already set up a GPG key, please refer to the GitHub documentation on Signing commits.
  7. Create a pull request to the master branch of the vechain/thor repository.
  8. Ensure your PR description clearly explains your changes and the problem it solves.
    • Explain the major changes you are submitting for review. Often it is useful to open a second tab in your browser where you can look through the diff yourself to remind yourself of all the changes you have made.
  9. Wait for feedback and be ready to address any requested changes.

Code Style and Guidelines

Code Style

  • We use gofmt to format our code. Please run gofmt . before committing your changes.

Code Guidelines

  • We follow the Effective Go guidelines. Please make sure your code is idiomatic and follows the guidelines.

Code Linting

  • We employ golangci-lint for code linting in our development process. It ensures that code adheres to established standards, and any changes that do not pass the linting checks will trigger an error during the Continuous Integration (CI) process.
  • You can run it locally by installing the golangci-lint binary and running make lint in the root directory of the repository.