Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

92 lines (62 loc) · 3.6 KB
Raw

Contributing to SealedTrust

First off, thank you for considering contributing to SealedTrust! It's people like you that make SealedTrust such a great tool for secure, blockchain-based transactions.

Table of Contents

  1. Code of Conduct
  2. What we are looking for
  3. How to contribute
  4. Style guide
  5. Community

Code of Conduct

This project and everyone participating in it is governed by the SealedTrust Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to this email.

What we are looking for

We love contributions from the community! There are many ways to contribute:

  • Reporting bugs
  • Suggesting enhancements
  • Writing documentation
  • Improving the user interface
  • Optimizing smart contracts
  • Adding new features
  • Fixing bugs

Check out the Issues page for current tasks we need help with.

How to contribute

Here's how you can contribute to SealedTrust:

  1. Clone the Repository: Start by cloning the SealedTrust repository.

    git clone https://github.com/jvc-byte/sealed-trust.git

  2. Create a Branch: Create a new branch for your contribution:

    git checkout -b feature/your-feature-name

  3. Make your Changes: Make your changes in your favorite editor.

  4. Test your Changes: Make sure to test your changes thoroughly. Run the existing test suite and add new tests if necessary:

    npm run build

  5. Commit your Changes: Use clear and meaningful commit messages:

    git commit -m "Add feature: your feature description"

  6. Push to your Fork:

    git push origin feature/your-feature-name

  7. Submit a Pull Request: Go to the SealedTrust repository and submit a pull request with a clear title and description.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Style guide

JavaScript Style Guide

We use ESLint with Airbnb's JavaScript Style Guide. Please make sure your code adheres to this style guide.

Solidity Style Guide

For Solidity code, we follow the Official Solidity Style Guide.

Commit Messages

We follow the Conventional Commits specification for our commit messages. This leads to more readable messages that are easy to follow when looking through the project history.

Community

Stay up to date and get in touch with the SealedTrust community:

Again, thank you for your interest in contributing to SealedTrust. We look forward to your contributions!