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

Latest commit

 

History

History
69 lines (46 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 4.23 KB
Raw

Contribution Guide

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

For topics that pertain to the architecture of TBD systems including tbDEX and the Decentralized Web Platform, this collaboration repo is a fine place to:

  • Propose ideas in our discussion forums
  • 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.

More specific issues, discussions, and other contributions are likely best raised in their respective project repositories. They follow similar tooling and processes to those described here. This repo reflects how our components come together.

Development Prerequisites

TBD projects are developed in a variety of languages and frameworks. Each project repo has a COLLABORATION.md file which describes:

  • Dependent software required, and how to install it for various systems
  • How to build and test
  • How to run and use the software

Communications

Roadmap

Our roadmap is public and follows a milestone model.

Issues

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

Project Board

Issues throughout the TBD projects are tracked on the project board. There are views available to find outstanding work by milestone and progress/status.

Discussions

Design discussions and proposals take place on GitHub Discussions

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

Continuous Integration

Projects will have links to their CI in the respective COLLABORATION.md files in their repos.

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 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.