Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

17 lines (11 loc) · 1.22 KB

How to contribute

Pocket Core is an open source project, and as such we welcome any contribution from anyone on the internet. Please read our Developer Setup Guide on how get started.

Please fork, code and submit a Pull Request for the Pocket Core Team to review and merge. We ask that you please follow the guidelines below in order to submit your contributions for review:

High impact or architectural changes

Reach out to us on Telegram and start a discussion with the Pocket Core Team regarding your change before you start working. Communication is key for open source projects and asynchronous contributions.

For an active research forum, checkout and post on our forum.

Coding style

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • (Optional) Use Editor Config to help your Text Editor keep the same formatting used throughout the project.
  • Code must be documented adhering to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the staging branch.