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 plently of opportunities for contribution.
As we work our way towards a beta release, we'll be creating more focused issues with the following labels:
bugdocumentationgood first issuehelp wanted
These issues are excellent canditates 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 here
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
WIPtag. - 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
WIPtag 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"
| Requirement | Tested Version | Installation Instructions |
|---|---|---|
Node.js |
v16.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 |
We plan on including a Docker container to support all local development soon.
- Running the
npm run test:nodecommand 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:browsercommand from the root of the project will run the tests in a browser environment- Please make sure there are no failing tests before switching your PR to ready for review! We hope to have this automated via a github action very soon.
Our preferred code style has been codified into eslint rules. Feel free to take a look here. 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.
| 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 |
npm run make-coverage-badges |
creates code coverage badges in README.md based on the code coverage result data generated by running tests |
npm run make-coverage-badges:ci |
creates code coverage badges and compare them against existing ones in README.md, errors out if they differ |