Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

39 lines (21 loc) · 2.75 KB

Community Contribution Guide

As a community member, you can contribute to the Pocket Protocol project in various ways. To standarize the workflow and ensure the quality of contributions, contributors must follow this guide. Failure to respect these guidelines will result in the rejection of the contribution in question.

Who is qualified to be a contributor?

More to come on this soon. If you want to contribute to this project, please apply on the forum.

Ways to contribute

As a contributor, you can participate in the project by doing one or several of the following tasks:

  • Use/Test/Hack: By using, testing, or trying to hack the protocol, you will be able to contribute by finding bugs, potential issues/vulnerabilities, or approaches to a better design. As a result, you will be fulfilling QA duties, as your work will contribute to ensuring the quality of the project, and your findings will help the development team to deliver a better and more secure protocol. Once you find a bug, issue, or improvement, you can communicate with the team on any related milestone, project, issue, or create a new one by following the issue creation guide.
  • Design and propose: You can design and propose better solutions to the various modules of the application are designed or implemented. You could also contribute by improving the existing functionality or security of the protocol. Any proposal should be done through a new milestone or project and must follow the milestone creation guide.
  • Develop: You can work on any open milestone, project, or issue by helping the development team accomplish the goal of existing milestones and submitting code that solves the problem by following the project's existing patterns and architecture. In order to be able to participate to developing the protocol, you have to follow the community developer guide.

Milestone Creation Guide

Follow this guide to comply with the project's standards on milestone creation.

Milestone Creation Guide

Issue Creation Guide

Follow this guide to comply with the project's standards on issue creation.

Issue Creation Guide

Community Developer Guide

Congratulations, if you're reading this, you truly are committed to building one of the most foundational projects for the future of Web3! We will present some guidelines to make sure that the interaction with other contributors is as smooth as possible.

Community Developer Guide

Integration Branch (Milestone) Merge Guide

Well Done! You finished your milestone, make sure to follow this guide to integrate your awesome changes in the next release.

Integration Branch (Milestone) Merge Guide