Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 7.03 KB

CONTRIBUTING.md

File metadata and controls

93 lines (73 loc) · 7.03 KB
Raw

Contribution Guide

This repo acts as a reference implementation of the Decentralized Web Node (DWN) specification. Before getting started, we highly recommend that you read the DWN spec doc. The specification is still in a draft / incomplete state. Anything related to the general architecture, features, or bugs with respect to DWN in general are best addressed via issues and pull requests within the spec repo. During early development, we'll be working on the specification and implementation in parallel. If you're confused about where to post your question, bug, or feature request, don't sweat! Go ahead and post it in either repo and we'll go ahead and move it if need be.

The general process we hope to follow is:

  • Submit a proposal as a PR in the DWN spec repo.
  • Iterate on the PR until it gets pulled into main.
  • Implement said proposal in this repo and submit a PR
  • Iterate on PR until its ready for main

Given that we're still in early stages of development, this contribution guide will certainly change as we near a beta release. Until then, things will be a bit ragtag but there's still plenty of opportunities for contribution.

As we work our way towards a beta release, we'll be creating more focused issues with the following labels:

  • bug
  • documentation
  • good first issue
  • help wanted

These issues are excellent candidates for contribution and we'd be thrilled to get all the help we can get! You can take a look at all of the Issues that match the labels above on the Issues tab

We suggest the following process when picking up one of these issues:

  • Check to see if anyone is already working on the issue by looking to see if the issue has a WIP tag.
  • Fork the repo and create a branch named the issue number you're taking on
  • Push that branch and create a draft PR
  • paste a link to the draft PR in the issue you're tackling
  • We'll add the WIP tag for you
  • work away. Feel free to ask any/all questions that crop up along the way
  • Switch the draft PR to "Ready for review"

Development

Prerequisites

Requirement Tested Version Installation Instructions
Node.js v18.17.0 There are many ways to install Node.js. Feel free to choose whichever approach you feel the most comfortable with. If you don't have a preferred installation method, you can visit the official downloads page and choose the the appropriate installer respective to your operating system

Running tests

  • Running the npm run test:node command from the root of the project will run all tests using node.
    • This is run via CI whenever a pull request is opened, or a commit is pushed to a branch that has an open PR.
  • Running the npm run test:browser command from the root of the project will run the tests in browser environments.
    • Please make sure there are no failing tests before switching your PR to ready for review! This validation is automated when you open a new pull request.

Developing and testing custom store implementations

Here is a guide on how to develop and test a custom implementation of the backend storage for DWN:

  1. Implement one or a combination of the DataStore, MessageStore, and EventLog interfaces.
  2. Import the TestSuite class for a new mocha test.
  3. Invoke TestSuite.runStoreDependentTests(...) in mocha, this will run all store dependent tests.
  4. Make sure that all store dependent tests pass.

NOTE: currently the test suite is only exported in the ESM module.

Example code:

import { TestSuite } from '@tbd54566975/dwn-sdk-js/tests';
import { yourMessageStore, yourDataStore, yourEventLog } from 'your-custom-stores';

describe('Custom data store implementation', () => {
  TestSuite.runStoreDependentTests({
    messageStore: yourMessageStore,
    dataStore   : yourDataStore,
    eventLog    : yourEventLog,
  });
});

Running benchmarks

Benchmarks should be run directly using node (e.g. node benchmarks/store/index/search-index.js).

Note that some benchmarks require that npm run build has been run beforehand.

Any dependencies needed by benchmarks should be in devDependencies (e.g. index-store for node benchmarks/store/index/index-store.js).

Code Style

Our preferred code style has been codified into eslint rules. Feel free to take a look at the relevant .eslintrc file. Running npm run lint will auto-format as much as eslint can. Everything it wasn't able to will be printed out as errors or warnings. Please make sure to run npm run lint before switching your PR to ready for review! We hope to have this automated via a github action very soon.

Code Guidelines

  1. A TODO in comment must always link to a GitHub issue.

Available NPM Commands

command description
npm run test:node runs tests and type checking
npm run test:browser runs tests against browser bundles in headless browser
npm run test:browser-debug runs tests against browser bundles in debug-ready Chrome
npm run build transpiles ts -> js as esm and cjs, generates esm and umd bundles, and generates all type declarations
npm run build:esm transpiles ts -> js as esm
npm run build:cjs transpiles ts -> js as cjs
npm run build:bundles generates esm and umd bundles
npm run build:declarations generates all type declarations
npm run clean deletes dist dir
npm run lint runs linter and displays all problems
npm run lint:fix runs linter and attempts to auto-fix all problems