Skip to content

Latest commit

 

History

History
112 lines (84 loc) · 6.15 KB

CONTRIBUTING.md

File metadata and controls

112 lines (84 loc) · 6.15 KB
Raw

Contribution Guide

There are many ways to be an open source contributor, and we're here to help you on your way! You may:

  • Propose ideas in our Web5 discord channel
  • Raise an issue or feature request in our issue tracker
  • Help another contributor with one of their questions, or a code review
  • Suggest improvements to our Getting Started documentation by supplying a Pull Request
  • Evangelize our work together in conferences, podcasts, and social media spaces.

This guide is for you.

Communications

Issues

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

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

  • bug
  • documentation
  • good first issue
  • help 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 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".

Discussions

Design discussions and proposals take place on our Web5 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.

Development Prerequisites

Requirement Tested Version Installation Instructions
Node.js 18.16.0 Introduction to Node.js
NPM 9.6.3 NPM Package Manager

TypeScript

This project is written in TypeScript, a strongly typed programming language that builds on JavaScript.

You may verify your node and npm installation via the terminal:

$ node --version
v18.16.0
$ npm --version
9.6.3

If you do not have Node.js installed, we recommend following the Introduction to Node.js guide.

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:

  • Start by proposing a change either in Issues (most appropriate for small change requests or bug fixes) or in Discussions (most appropriate for design and architecture considerations, proposing a new feature, or where you'd like insight and feedback)
  • Cultivate consensus around your ideas; the project leads will help you pre-flight how beneficial the proposal might be to the project. Developing early buy-in will help others understand what you're looking to do, and give you a greater chance of your contributions making it into the codebase! No one wants to see work done in an area that's unlikely to be incorporated into the codebase.
  • 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, first:
  • Squash your commits into a single one (or an appropriate small number of commits), and rebase atop the upstream main branch. This will limit the potential for merge conflicts during review, and helps keep the audit trail clean. A good writeup for how this is done is here, and if you're having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like rebasing assistance in your PR! We're here to support you.
  • 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 optionally open a discussion about its contents before moving forward.
  • Remain responsive to follow-up questions, be open to making requested changes, and... You're a contributor!
  • And remember to respect everyone in our global development community. Guidelines are established in our CODE_OF_CONDUCT.md.

Running tests

  • Running the npm run test:node --ws 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 --ws command 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.
  • You can also run npm run test:node -w=packages/DIR or npm run test:browser -w=packages/DIR from the root of the project to run tests for a single package. For example, to run the tests only for the web5 package run npm run test:node -w=packages/web5.