Node Docs
Product DocsTechnical DocsLearning & GovernanceUseful Links
  • Node documentation for cheqd network
  • 👉Getting Started
    • Setup a new cheqd node
      • Pre-Requisites & Requirements
      • (Alternative) Install with Docker
      • Configure cheqd node
      • Configure cosmovisor
    • Command Line usage
      • Manage keys
      • Manage accounts
      • Manage a node
      • Make transactions
      • Use fee abstraction
  • 🏦Validator Guides
    • Guide for validators
      • FAQs for validators
      • Optimising disk storage with pruning
      • Troubleshooting consistently high CPU/memory loads
      • Unjailing a jailed validator
      • Move validator to a different machine
      • Backup and restore node keys with Hashicorp Vault
    • Network-wide Software Upgrades
      • Upgrade Guides
        • Upgrade to v0.6.x
        • Upgrade to v2.x (with Ubuntu 24.04 LTS upgrade)
        • Upgrade to v3.x
        • Upgrade to v3.1.x
      • Creating a software upgrade proposal
      • Upgrade Process
  • 🧑‍💻Developing on cheqd
    • Building from source
      • Build with Docker
      • Run a localnet with Docker
    • Indexers
      • SubQuery
  • Architecture
    • Architecture Decision Record (ADR) Process
    • Identity ADRs
    • List of ADRs
      • ADR 001: Payment mechanism for issuing credentials
      • ADR 002: Importing/exporting mnemonic keys from Cosmos
      • ADR 003: Command Line Interface (CLI) tools
      • ADR 004: Token fractions
      • ADR 005: Genesis parameters
      • ADR 006: Community tax
      • ADR 007: Revocation registry
      • ADR 011: AnonCreds
      • ADR Template
  • 🤝Contributing to cheqd
    • Contributor Guide
    • License
    • Code of Conduct
    • Security Policy
  • 🆘Support
    • System Status
    • Slack Channel
    • Discord
Powered by GitBook
LogoLogo

General

  • Website
  • Blog
  • Get $CHEQ

Product Docs

  • Product Docs
  • cheqd Studio
  • Creds.xyz

Technical Docs

  • Node Docs
  • GitHub
  • Block Explorer

Learning Docs

  • Learning Docs
  • Governance Docs
  • Governance Forum
  • Governance Explorer
On this page
  • 🧑‍⚖️ Code of Conduct
  • ❓ Got a question or problem?
  • 🪲 Found a bug?
  • ❣️ Missing a feature?
  • Submission Guidelines
  • Submitting an Issue
  • Submitting a Pull Request (PR)

Was this helpful?

Edit on GitHub
Export as PDF
  1. Contributing to cheqd

Contributor Guide

Last updated 2 years ago

Was this helpful?

We would love for you to contribute to cheqd and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow.

🧑‍⚖️ Code of Conduct

Help us keep cheqd open and inclusive. Please read and follow our

❓ Got a question or problem?

You can get help for any questions or problems that you have on through the following channels:

  • Check if your question/problem is already covered under our documentation sites:

    • (basics for general audience)

  • Raise a bug report or feature request using the "Issue" tab on Github

  • Ask the question on our or

🪲 Found a bug?

❣️ Missing a feature?

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. Often, developers find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  2. In your forked repository, make your changes in a new git branch:

    git checkout -b my-fix-branch develop
  3. Create your patch, including appropriate test cases.

  4. Check that all workflow actions for linting / build / test pass.

  5. Push your branch to GitHub:

    git push origin my-fix-branch
  6. In GitHub, send a pull request to cheqd-node:develop. The develop branch is where all pending PRs should be targetted for inclusion in the next release.

If you find a bug in the source code, you can help us by to our . Even better, you can with a fix.

You can request a new feature by to our GitHub Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

Small Features can be crafted and directly .

You can file new issues by selecting from our and filling out the issue template.

Search for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

the repository.

Commit your changes using a descriptive commit message that follows

🤝
Code of Conduct
Node / cheqd network
Identity features / SDKs
Governance Framework
Product Suite & Updates
Learn about cheqd
Community Slack
Discord
submitting an issue
GitHub Repository
submit a Pull Request
submitting an issue
submitted as a Pull Request
new issue templates
GitHub
Fork
cheqd-node
Conventional Commits convention