mirror of
https://github.com/signalapp/Signal-Android.git
synced 2026-02-15 07:28:30 +00:00
(■_■¬)
@@ -5,19 +5,27 @@
|
||||
Great! You don't have to apply for it. It's opt-in by default!
|
||||
|
||||
##### Don't want BTC? Just in for the glory?
|
||||
Cool! Just add the word `FREEBIE` somewhere in your **git commit message.** (Note that git commit message is not the same as GitHub's Pull Request description).
|
||||
Cool! Just add the word `FREEBIE` somewhere in your **Git commit message.** (Note that Git commit message is not the same as GitHub's pull request description).
|
||||
|
||||
## What is BitHub?
|
||||
_Quoting the [BitHub repository](https://github.com/WhisperSystems/BitHub)_
|
||||
>
|
||||
> BitHub is a service that will automatically pay a percentage of Bitcoin funds for every submission to a GitHub repository.
|
||||
>
|
||||
> More information can be found in our [announcement blog post](https://whispersystems.org/blog/bithub).
|
||||
|
||||
## Getting paid for your contributions
|
||||
On top of the glory, fame and good vibes that you get from contributing to open source projects, Open Whisper Systems repositories reward contributors also with Bitcoins. In practice this means the following:
|
||||
|
||||
1. You code
|
||||
1. You make sure you have a valid email address as your [`user.email`](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#Your-Identity) setting in Git
|
||||
1. You submit a pull request
|
||||
1. Your contribution gets merged
|
||||
1. You receive a BitHub reward
|
||||
1. You receive a BitHub reward to your email
|
||||
|
||||
You don't need to put your Bitcoin address to your commits. The rewards are handled by Coinbase. You will get an email from them to **your git commit email address**. The email contains all the necessary details on how to claim your Bitcoins.
|
||||
You don't need to put your Bitcoin address to your commits. The rewards are handled by Coinbase. You will get an email from them to **your Git commit email address**. The email contains all the necessary details on how to claim your Bitcoins.
|
||||
|
||||
Let's see an example. Here's a merged commit:
|
||||
Let's see an example. Here's a merged imaginary commit:
|
||||
```
|
||||
commit 91ab895dcc7f0b3f1058a909192730f7a69359f9
|
||||
Author: Aristotle <primе@mov.еr>
|
||||
@@ -27,14 +35,14 @@ Date: Thu May 7 05:47:01 -352 +0200
|
||||
```
|
||||
In this case the BitHub reward would be sent to the address `primе@mov.еr`
|
||||
|
||||
Because the reward is handled by email please make sure that you have a working email address in your git settings (try `git config user.email` to see your current address).
|
||||
Because the reward is handled via email please make sure that you have a working email address in your Git settings (try `git config user.email` to see your current address).
|
||||
If a BitHub reward email has already been sent to you and you didn't have a working email address in that specific commit, then consider the reward gone for good :crying_cat_face: :money_with_wings:
|
||||
|
||||
## How do I know if my contribution is eligible for the BitHub reward?
|
||||
If you have submitted a pull request you already are eligible. BitHub rewards are opt-in by default. You don't have to ask or apply for them. Just make a contribution, open a pull request and when it has been merged you will receive it automatically to your git commit email address.
|
||||
If you have submitted a pull request you already are eligible. BitHub rewards are opt-in by default. You don't have to ask or apply for them. Just make a contribution, open a pull request and when it has been merged you will receive it automatically to your Git commit email address.
|
||||
|
||||
## I want to help for free!
|
||||
Awww... sweet! You can opt-out of the BitHub reward by adding the word `FREEBIE` in your git commit message. Usually people add it to the last line as `// FREEBIE`. Please note that the git commit message is different from GitHub's Pull Request description. You don't have to write anything about the reward to the PR description. Even though the PR description has a ready made checklist that also includes a reminder for the BitHub reward, it's just a reminder for you that you have acknowledged the reward system. The BitHub bot only looks for the merged commit message for the magic word `FREEBIE`.
|
||||
Awww... sweet! You can opt-out of the BitHub reward by adding the word `FREEBIE` in your Git commit message. Usually people add it to the last line as `// FREEBIE`. Please note that the Git commit message is different from GitHub's pull request description. You don't have to write anything about the reward to the PR description. The PR description does have a template checklist which will remind you of the BitHub reward, but it's just to remind you to make the choice of opting in or out. In the end the BitHub bot only looks for the merged commit message for the magic word `FREEBIE` – nothing else matters.
|
||||
|
||||
Here's an example of what a free contribution commit message might look like:
|
||||
```
|
||||
@@ -46,21 +54,21 @@ Closes #3131
|
||||
// FREEBIE
|
||||
```
|
||||
|
||||
## Automatically add `FREEBIE` to all commit messages
|
||||
If you are bored of writing `FREEBIE` every time you commit, or if you just constantly forget to add it, you can create a template git commit message for the Open Whisper System projects.
|
||||
### Automatically add `FREEBIE` to all commit messages
|
||||
Are you bored of writing `FREEBIE` every time you commit? Do you constantly forget to add it at the bottom of your commit messages? Don't worry, you can automate it by creating a template Git commit message for the Open Whisper System projects.
|
||||
|
||||
For example create a file in your home directory `~/.git_commit_template_ows_repos.txt` with the content:
|
||||
```
|
||||
// FREEBIE
|
||||
```
|
||||
|
||||
Then `cd` to your repository and tell git where your template file is:
|
||||
Then `cd` to your repository and tell Git where your template file is:
|
||||
```
|
||||
cd Signal-Android
|
||||
git config commit.template ~/.git_commit_template_ows_repos.txt
|
||||
```
|
||||
|
||||
Now all your commit messages will have `// FREEBIE` automatically.
|
||||
Now all your commit messages will have `// FREEBIE` by default.
|
||||
|
||||
## How much is the reward?
|
||||
It depends on the size of the pot.
|
||||
|
||||
Reference in New Issue
Block a user