Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.43 KB

Contributing

For now master is the main branch and code improvements are made in topic branches that get merged into it. Eventually there will be specific release branches, but for now master is the release branch.

  1. Create a branch named initials-topic or ticket tag like esw-190
  2. dd commits at whatever pace/detail necessary (these are mostly for your benefit)
  3. Push your named branch
  4. Add a short description of what the PR accomplishes
  5. If possible add screenshots (use shift-command-4-space-click to capture the iOS simulator window)

Due to the small team size, code reviews are mostly to inform other members what's going on. Use GitHub's inline comment feature to leave notes for others to read and reply.

Merging a Pull Request

  1. Select "Squash and merge" from the drop-down Merge button.
  2. Delete the branch (as the UI recommends) to keep the repo clean.

Go Development

Planetary’s underlying SSB protocol implementation is written in Go (see cryptoscope/ssb). The GoSSB folder contains an Xcode project that packages cryptoscope/ssb as an XCFramework that works across Apple’s various platforms and architectures. GoSSB.xcframework is included in this repository so that contributors don’t need to install a full Go stack to work on the iOS app. More information about the GoSSB.xcframework can be found in its README