Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
128 lines (85 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

128 lines (85 loc) · 4.58 KB
Raw

Contribution Guide

This repo acts as a one-stop, opinionated toolkit for all things Self Sovereign Identity (SSI). Before contributing, we recommend that you review the README, dig into some of the specifications it mentions, take a look at recent PRs, and issues. The SDK is intended to be used in any go project. Our SSI Service makes use of the SDK for much of its core functionality.

When you're ready you may:

  • Propose ideas in our SSI discord channel
  • Raise an issue or feature request in our issue tracker
  • Help another contributor with one of their questions, or a code review

Development Prerequisites

Requirement Tested Version Installation Instructions
Go 1.23.2 go.dev
Mage 1.13.0-6 magefile.org

Go

This project is written in Go, a modern, open source programming language. Go was chosen because of its speed, simplicity, and versatility. Go is a powerful language that's easy to pick up. It works across ecosystems, and even works with WASM.

You may verify your go installation via the terminal:

$> go version
go version go1.23.2 darwin/amd64

If you do not have go, we recommend installing it by:

MacOS

Homebrew
$> brew install go

Mage

The build is run by Mage.

You may verify your mage installation via the terminal:

$> mage --version
Mage Build Tool v1.13.0-6-g051a55c
Build Date: 2022-05-02T19:53:34-07:00
Commit: 051a55c
built with: go1.17.6

MacOS

Homebrew
$> brew install mage

Build (Mage)

$> mage build

Test (Mage)

$> mage test

Clean / Build / Test (Mage)

$> mage cbt

Communications

Issues

Anyone from the community is welcome (and encouraged!) to raise issues via GitHub Issues.

We label issues according to their functionality (e.g. dids, sign-verify, credentials, bug, documentation, testing and more). If you don't see an appropriate label for an issue feel free to request a new one.

We use GitHub Projects to track our work.

Discussions

Design discussions and proposals take place in our SSI discord channel.

We advocate an asynchronous, written debate model - so write up your thoughts and invite the community to join in!

Continuous Integration

Build and Test cycles are run on every commit to every branch using GitHub Actions.

Contribution

We review contributions to the codebase via GitHub's Pull Request mechanism. We have the following guidelines to ease your experience and help our leads respond quickly to your valuable work:

Code

Process

We suggest the following process when picking up an issue:

  • Check to see if anyone is already working on the issue by looking to see if the issue has any comments saying so.
  • Fork the repo and create a branch containing the issue number you're working on
  • Push that branch and create a PR, mentioning the issue it relates to in the description.
  • You may also choose to paste a link to the PR in the original issue.

If you don't see an issue for what you would like to work on, have an idea for a new features found a bug, or have a question...

  • Start by proposing a change either in GitHub Issues or on our Discord in the #ssi channel
  • Fork the repo into your own namespace/remote
  • Work in a dedicated feature branch. Atlassian wrote a great description of this workflow
  • When you're ready to offer your work to the project:
    • Open a PR in the project to bring in the code from your feature branch.
    • The maintainers noted in the CODEOWNERS file will review your PR and work with you to get it merged.