Mirror/robosats
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats.git synced 2024-12-14 11:26:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ca3f7cb222
robosats/docs/_pages/contribute/01-development.md
okada-blue ed062416db
Edit Multiple docs (#712) 
* Update 01-development.md

Update Communication Channels channels to reflect removal of Twitter and Telegram, and emphasize SimpleX, Nostr, and Matrix chats

* Update 02-languages.md

Update Telegram verbiage to reference SimpleX instead.

* Update 04-guides.md

Update Telegram verbiage to reference SimpleX instead.

* Update 05-art.md

Update Telegram verbiage to reference SimpleX instead.

* Update 06-outreach.md

Update Twitter verbiage and reference Nostr instead

* Update 00-quicks-start-guide.md

Update verbiage slightly. Add more info and links.

* Update 01-lightning.md

Add rough draft to provide overview of Lightning Network and its relation to RoboSats

* Update 02-tor.md

Provide rough draft of introduction to TOR.

* Update 03-access.md

Add access method via Android app APK. Adjust slight typos and some wording for clarity.

* Update 01-trade-pipeline.md

Add TOC, swap steps and pictures placement, adjust small typos and wording.

Picture was swapped with the steps because I think the picture can be slightly overwhelming versus a simple list of steps. The pictures are great but they are a lot to throw at someone right when they open the very first doc under "Understand" to learn about RoboSats.

* Update 02-robots.md

Clean up hyperlinks, adjust grammar slightly.

* Update 03-premium.md

Update verbiage, adjust grammar slightly.

* Update 03-premium.md

Add paragraphs on advice for choosing a premium

* Update 04-bonds.md

Various changes to verbiage and adding/updating information. Grammar fixes, remove reference to Telegram.

* Update 05-trade-escrow.md

Clean up hyperlinks, adjust some wording

* Update 06-disputes.md

Rough draft of disputes section. Committed changes are a placeholder for a longer and more detailed version of the dispute process.

* Update 07-wallets.md

Fix typos, grammar edits, add new section at bottom

* Update 08-limits.md

Rough draft of new content in the limits docs

* Update 09-swaps.md

Adjust "on-chain" to "on chain" and "sats" to "Sats" for consistency across other docs. Slight grammar fixes.

* Update 10-telegram.md

Small grammar fixes, clean up formatting and add table of contents

* Update 12-prices.md

Add verbiage note about explicit pricing method, clean up hyperlinks

* Update 13-fees.md

Clean up hyperlinks, small spelling fixes

* Update 14-on-chain-payouts.md

Add table of contents, small grammar fixes, adjust formatting

* Update 07-wallets.md

Change "on chain" to "on-chain"

* Update 09-swaps.md

Change "on chain" to "on-chain"

* Update 02-tor.md

Add note when using TOR and experiencing connection issues
2023-07-24 17:50:17 +00:00

7.6 KiB
Raw Blame History

layout title permalink sidebar toc toc_sticky src
single Develop RoboSats /contribute/code/
title nav
<img id="side-icon-verybig" src="/assets/vector/code.svg"/>Code contribute
true true _pages/contribute/01-development.md

Everyone can contribute to the development of the RoboSats open source project. If you're looking for somewhere to start contributing, then check out the issue list sharing the "good first issue" label; such issues are good for newcomers.

This contributing guide is based on the Bisq contributing guide. Following best FOSS practices helps development remain organized as the project grows with new features and is continually optimized. Future contibutors will thank you for following these best practices and making your work easier to build on!

Communication Channels

!!! Beware of scammers impersonating RoboSats admins. Admins will NEVER privately message/call you.

  • Simplex: RoboSats Main Group. Got questions or a problem? Find community-driven support in the public SimpleX group chat. If you're wanting to hang out with other cool robots and learn more about RoboSats, then those discussions happen in SimpleX, Nostr, and Matrix group chats.

  • Nostr: RoboSats General Group. Hang out with other cool robots and do not hesitate to ask questions about RoboSats! Also, the RoboSats Nostr account (npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82) provides important project updates, tips and tricks of using RoboSats, and other privacy-centric commentary. Questions and engagement are welcome. Keep in mind: problems requiring RoboSats staff support should be directed to the main SimpleX group chat instead, where responses are quicker and staff can further investigate your problem.

  • Matrix: RoboSats Development Group. Main developer communication group chat where open and technical discussions about development takes place. Discussion about code changes happens in GitHub issues and pull requests (PRs).

Contributor Workflow

All RoboSats contributors submit changes via pull requests. The workflow is as follows:

  • Fork the repository
  • Create a topic branch from the main branch
  • Commit patches
  • Squash redundant or unnecessary commits
  • Submit a pull request from your topic branch back to the main branch of the main repository
  • Make changes to the pull request if reviewers request them and request a re-review

Pull requests should be focused on a single change. Do not mix, for example, refactorings with a bug fix or implementation of a new feature. This practice makes it easier for fellow contributors to review each pull request.

Reviewing Pull Requests

Robosats follows the review workflow established by the Bitcoin Core project. The following is adapted from the Bitcoin Core contributor documentation:

Anyone may participate in peer review which is expressed by comments in the pull request. Typically reviewers will review the code for obvious errors, as well as test out the patch set and opine on the technical merits of the patch. Project maintainers take into account the peer review when determining if there is consensus to merge a pull request (remember that discussions may have been spread out over GitHub and Telegram). The following language is used within pull-request comments:

  • ACK means "I have tested the code and I agree it should be merged";
  • NACK means "I disagree this should be merged", and must be accompanied by sound technical justification. NACKs without accompanying reasoning may be disregarded;
  • utACK means "I have not tested the code, but I have reviewed it and it looks OK, I agree it can be merged";
  • Concept ACK means "I agree in the general principle of this pull request";
  • Nit refers to trivial, often non-blocking issues.

Please note that Pull Requests marked NACK and/or GitHub's Change requested are closed after 30 days if not addressed.

Developer Compensation (Pilot Program)

Check the current state of the Developer Compensated tasks in the Github Project

At the moment, RoboSats is a young and unfunded project, but has shown the ability to generate enough revenue to barely cover operational costs. A developer compensation program is the best way to ensure the sustained support of the code base. For the time being, code contributions to the core project will be given small rewards more akin to a tip than a meaningful monetary compensation. The pilot procedure for compensated development:

  1. The developer opens a PR with the description of the work that will be done, optionally including the amount of Sats he thinks the work deserves.
  2. An offer/negotiation takes place to set an amount of Sats until agreed upon. Everyone is welcome to express opinion on whether the compensation is right for the PR.
  3. The work happens: buidl, buidl, buidl!
  4. The review takes place. Once maintainers give the OK for the merge...
  5. The developer submits an LN invoice (with a long expiration time). The invoice is paid at merge.

Every step (negotiation, code submission, review and invoice submission) must take place publicly in GitHub (i.e., no private messaging and the like). Please contact the team lead for development (@reckless-satoshi) upfront if you have doubts whether your contribution is suitable for compensation. Currently, only contributions to the frontend or backend core functionality and maintainence are eligible for compensations (for the time being, that excludes: art, translations, etc.).

Style and Coding Conventions

Configure Git user name and email metadata

See https://help.github.com/articles/setting-your-username-in-git/ for instructions.

Write well-formed commit messages

From https://chris.beams.io/posts/git-commit/#seven-rules:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters (*)
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters (*)
  7. Use the body to explain what and why vs. how

Sign your commits with GPG

See https://github.com/blog/2144-gpg-signature-verification for background and https://help.github.com/articles/signing-commits-with-gpg/ for instructions.

Use an editor that supports Editorconfig

The .editorconfig settings in this repository ensure consistent management of whitespace. Most modern editors support it natively or with plugin. See http://editorconfig.org for details.

Keep the git history clean

It's very important to keep the git history clear, light and easily browsable. This means contributors must make sure their pull requests include only meaningful commits (if they are redundant or were added after a review, they should be removed) and no merge commits.