Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

35 lines (20 loc) · 2.04 KB

Contribution Guide

Our goal is to make contributing a Diem Improvment Protocol (DIP), or make changes to the DIP website, easy and transparent.

Contributing a DIP

To contribute a DIP, follow the DIP process guidelines. For example, one way to contribute a DIP is to file a GitHub issue in this repo, gather feedback, and then, once the discussion is over, create a pull request with your DIP in the diem/dips folder of this repo.

Documentation

The documentation for https://dip.diem.com is published from this repo. The site is open source, and is built using Docusaurus.

If you are familiar with Markdown, you can start contributing!

Pull Requests

During the initial phase of development, we plan to only audit and review the pull requests. As the codebase stabilizes, we will be able to accept pull requests from the community.

To submit your pull request:

  1. Fork the dip repo and create your branch from master.
  2. Create your DIP locally.
  3. Complete the Contributor License Agreement (CLA), if you haven't already done so. See below for information about the CLA.
  4. Submit your pull request.

Contributor License Agreement

For your pull requests to be accepted by any Diem project, you will need to sign a CLA. You will need to do this only once to work on any Diem open source project. Individuals contributing on their own behalf can sign the Individual CLA. If you are contributing on behalf of your employer, please ask them to sign the Corporate CLA.

Code of Conduct

Please refer to the Code of Conduct for guidelines on interacting with the community.

Issues

Diem uses GitHub issues to track bugs. Please include necessary information and instructions to reproduce your issue.