From b89800a5f6afcfd0e47916b8e660155a5b8fb35b Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Sun, 8 Dec 2019 14:02:14 +0100 Subject: [PATCH 1/7] Add "are you the Guy?" section --- CONTRIBUTING.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0b1666e146..af87bfcfde6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,36 @@ # Contributing to Bisq -Anyone is welcome to contribute to Bisq. This document provides an overview of how we work. If you're looking for somewhere to start contributing, see the [good first issue](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list. +Read on to find out if taking part in the development of Bisq is for you and how to do it! + +## Are you "the guy"? + +Java God, Bitcoin Native, Marketing Genius, Cypherpunk, Testing Machine, or simply someone who likes the idea of Bisq? Anyone is welcome to contribute! However, Bisq is no classic organization, there is no boss, there is no working hours and there is no classic payment. In short, Bisq is not for everyone. + +**What is there to work on?** You have to be able to find and work a problem on your own. In general, we do not assign stuff to people, there is no specification to be implemented, there is no given way forward. You yourself have to find, choose and pick something to work on. If you get stuck, we are keen to help, but please do not wait for us to take your hand. Also, you can spend as much (or little) time as you want and when you want to - Bisq still is an open source project. + +**Will you get paid?** Well, yes and no. With Bisq, there is no classic funding or investors, so there is no payout of fiat money. +- Yes, because there is the DAO. The DAO allows for compensation requests to be filed and voted on. If such a voting goes in your favor, you receive BSQ, a colored bitcoin token. Sell your BSQ and you get your fiat eventually. +- No, because the market is still very small. We can sustain a few full-timers (paying rent, tax, small stuff) but do not expect to get rich fast and easy just now. + +The more correct way to see payment is "compensation". By earning BSQ, you invest in the Bisq project (just like other startups do it). But make no mistake, the DAO has only been operating for a few months now. Eventually, Bisq will create serious revenue. + +**Tools?** If you want to develop code, we expect you to know your ways around Git and Java. Then comes testing, JavaFX, Gradle, Github, ... As for non-functional skills, we love to see people knowing their ways around P2P networks, cryptography, security, privacy, ... + +**Carreer?** Start small, go bigger. If we like your work, we might just ask you to take on a more official role. Maybe someday you are the guy improving this document (again). + + + + +Still here? Nice. You are hired. On to the grind. + + + + + + + + +This document provides an overview of how we work. If you're looking for somewhere to start contributing, see the [good first issue](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list. ## Communication Channels From 9964c792f7da261414894623fd5c82dbe14f2b09 Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Mon, 9 Dec 2019 13:53:35 +0100 Subject: [PATCH 2/7] Added "Get started" section --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af87bfcfde6..37a19d1858c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,15 @@ The more correct way to see payment is "compensation". By earning BSQ, you inves Still here? Nice. You are hired. On to the grind. +# Getting started +Join Gibhub if you haven't already, fork the Bisq repository, configure your local git ([username](https://help.github.com/articles/setting-your-username-in-git/), [commit signing](https://help.github.com/articles/signing-commits-with-gpg/)), clone your Bisq-fork to disk, do a compile run `./gradlew build`. +Now you are ready to roll. Pick something off the [Good First Issue List](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), pick any other issue, do some testing, spot a bug, report it and fix it, maybe there is something in the UI that needs cosmetic work. +Now that you have picked yourself something to work on, be vocal about it! Claim good first issues, or any issues, by simply leaving a comment saying that this is being worked on, join [Keybase](https://keybase.io/team/bisq). Once there, introduce yourself in *#introductions*, get help in *#dev-onboarding* if your setup fights you, use *#dev* to see if the task you picked is a good way forward (you do not have to do that for good first issues) and join other channels if you want to. + +Go on and do the actual work. From 1ad01ca7760bf78ab492cadbdd811c6c81e8b2d5 Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Mon, 9 Dec 2019 13:41:54 +0100 Subject: [PATCH 3/7] Refactored "Pull request rules" section Refactored the stuff that has already been there and added the bits and peaces according to a recent call. --- CONTRIBUTING.md | 120 +++++++++++++++++++----------------------------- 1 file changed, 46 insertions(+), 74 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37a19d1858c..d6d90d14e20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,90 +34,62 @@ Now that you have picked yourself something to work on, be vocal about it! Claim Go on and do the actual work. - - -This document provides an overview of how we work. If you're looking for somewhere to start contributing, see the [good first issue](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list. - - -## Communication Channels - -Most communication about Bisq happens in the [Bisq Slack workspace](https://bisq.network/slack-invite). - -Discussion about code changes happens in GitHub issues and pull requests. - -Discussion about larger changes to the way Bisq works happens in issues the [bisq-network/proposals](https://github.com/bisq-network/proposals/issues) repository. See https://docs.bisq.network/proposals.html for details. - - -## Contributor Workflow - -All Bisq contributors submit changes via pull requests. The workflow is as follows: - - - Fork the repository - - Create a topic branch from the `master` branch - - Commit patches - - Squash redundant or unnecessary commits - - Submit a pull request from your topic branch back to the `master` 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 on its merits and to give a clear ACK/NACK (see below). - - -## Reviewing Pull Requests - -Bisq follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review): - -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, mailing list and IRC discussions). The following language is used within pull-request comments: - +# Pull request rules + +Please honor the list of rules below for your pull request to get merged. Due to very limited resources, we are forced to enforce these quite rigorously. + +## Honor Git best practice + - Create a topic branch off master + - Commit little, commit often + - Maintain a clean commit history (no merges commits!, use rebase and force-push if necessary) + - Use meaningful commit subjects AND description (then, now, good, bad, risks) + - Do so in a well-formed manner (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 + +## Respect Bisq's coding style + - The .editorconfig settings in this repository ensure consistent management of whitespace, line endings and more. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. See also bisq-network/style#10. + - Also, please honor the issues in the [bisq-network/style](https://github.com/bisq-network/style/issues) repository + - Do not commit import reorgs or any other non-changes! + + +## Test your code! + - Create automated tests for your work. JUnit is available. If you are fixing a bug, create a test that demonstrates the bug by failing. Then fix the bug. + - If automated testing is not feasible (we know it can be hard - working on it ...), provide a textual testing procedure (which we can include in our manual testing checklist): setup, prerequisits, steps, expected results + - If that is not possible either, provide some info (numbers, screenshots, testing procedure) on how you tested your stuff + - If all is lost, state why you have not been able to do the above. + +## Create a pull request +- Pull requests have to be focused on a single change. Do not mix unrelated stuff. +- Use meaningful title and description + - provide some context, how did stuff work before, how does it work now, why is that better + - are there some introduced/mitigated risks, maybe for backwards compatibility + - how you tested your stuff (so we can do so as well if we feel so) + - and of course, reference issues (if applicable) with the use of [keywords](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) +- Wait for your pull request to be reviewed + +## Pull request review prodecure +Bisq follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review): - `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. - +In case you receive a NACK and/or `change requested` + - react within 30 days, or else, your pull request will be rejected automatically + - **re-request a review** after adressing a change request (because we almost always only look at "review required" pull request because of resource constraints) ## Compensation -Bisq is not a company, but operates as a _decentralized autonomous organization_ (DAO). For any work merged into Bisq's `master` branch, you can [submit a compensation request](https://docs.bisq.network/dao/phase-zero.html#how-to-request-compensation) and earn BSQ (the Bisq DAO native token). Learn more about the Bisq DAO and BSQ [here](https://docs.bisq.network/dao/phase-zero.html). - - -## 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 - -See also [bisq-network/style#9](https://github.com/bisq-network/style/issues/9). - -### 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](.editorconfig) settings in this repository ensure consistent management of whitespace, line endings and more. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. See also [bisq-network/style#10](https://github.com/bisq-network/style/issues/10). - -### 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_. - -### Additional style guidelines +Your pull request got merged? great, congrats and thanks for making Bisq more better. -See the issues in the [bisq-network/style](https://github.com/bisq-network/style/issues) repository. +For any work merged into Bisq's `master` branch, you can [submit a compensation request](https://docs.bisq.network/dao/phase-zero.html#how-to-request-compensation) and earn BSQ (the Bisq DAO native token). Learn more about the Bisq DAO and BSQ [here](https://docs.bisq.network/dao/phase-zero.html). ## See also From aaa3307137a0da8cc60ffc42d5c6f74c19903abe Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Mon, 9 Dec 2019 13:43:14 +0100 Subject: [PATCH 4/7] Refactored "Further reading" added youtube links --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6d90d14e20..530c2612fb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,8 +92,10 @@ Your pull request got merged? great, congrats and thanks for making Bisq more be For any work merged into Bisq's `master` branch, you can [submit a compensation request](https://docs.bisq.network/dao/phase-zero.html#how-to-request-compensation) and earn BSQ (the Bisq DAO native token). Learn more about the Bisq DAO and BSQ [here](https://docs.bisq.network/dao/phase-zero.html). -## See also +# Further reading/other resources worth checking + - tech session on [youtube](https://www.youtube.com/watch?v=ulmUVh3XjRg&list=PLFH5SztL5cYOtcg64PntHlbtLoiO3HAjB) + - dev-calls on [youtube](https://www.youtube.com/watch?v=YnTA3p-5v00&list=PLFH5SztL5cYN1m9v_NvpXxvP7_XIKF3At) - [contributor checklist](https://docs.bisq.network/contributor-checklist.html) - [developer docs](docs#readme) including build and dev environment setup instructions From 092799a0917ca6bb12f1fc9bb0d94da47663f7ca Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Wed, 11 Dec 2019 12:11:43 +0100 Subject: [PATCH 5/7] Adjusted header levels --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 530c2612fb8..ff92b7af76e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ The more correct way to see payment is "compensation". By earning BSQ, you inves Still here? Nice. You are hired. On to the grind. -# Getting started +## Getting started Join Gibhub if you haven't already, fork the Bisq repository, configure your local git ([username](https://help.github.com/articles/setting-your-username-in-git/), [commit signing](https://help.github.com/articles/signing-commits-with-gpg/)), clone your Bisq-fork to disk, do a compile run `./gradlew build`. @@ -34,11 +34,11 @@ Now that you have picked yourself something to work on, be vocal about it! Claim Go on and do the actual work. -# Pull request rules +## Pull request rules Please honor the list of rules below for your pull request to get merged. Due to very limited resources, we are forced to enforce these quite rigorously. -## Honor Git best practice +### Honor Git best practice - Create a topic branch off master - Commit little, commit often - Maintain a clean commit history (no merges commits!, use rebase and force-push if necessary) @@ -52,19 +52,19 @@ Please honor the list of rules below for your pull request to get merged. Due to 6. Wrap the body at 72 characters 7. Use the body to explain what and why vs. how -## Respect Bisq's coding style +### Respect Bisq's coding style - The .editorconfig settings in this repository ensure consistent management of whitespace, line endings and more. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. See also bisq-network/style#10. - Also, please honor the issues in the [bisq-network/style](https://github.com/bisq-network/style/issues) repository - Do not commit import reorgs or any other non-changes! -## Test your code! +### Test your code! - Create automated tests for your work. JUnit is available. If you are fixing a bug, create a test that demonstrates the bug by failing. Then fix the bug. - If automated testing is not feasible (we know it can be hard - working on it ...), provide a textual testing procedure (which we can include in our manual testing checklist): setup, prerequisits, steps, expected results - If that is not possible either, provide some info (numbers, screenshots, testing procedure) on how you tested your stuff - If all is lost, state why you have not been able to do the above. -## Create a pull request +### Create a pull request - Pull requests have to be focused on a single change. Do not mix unrelated stuff. - Use meaningful title and description - provide some context, how did stuff work before, how does it work now, why is that better @@ -73,7 +73,7 @@ Please honor the list of rules below for your pull request to get merged. Due to - and of course, reference issues (if applicable) with the use of [keywords](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) - Wait for your pull request to be reviewed -## Pull request review prodecure +### Pull request review prodecure Bisq follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review): - `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; @@ -85,14 +85,14 @@ In case you receive a NACK and/or `change requested` - react within 30 days, or else, your pull request will be rejected automatically - **re-request a review** after adressing a change request (because we almost always only look at "review required" pull request because of resource constraints) -## Compensation +### Compensation Your pull request got merged? great, congrats and thanks for making Bisq more better. For any work merged into Bisq's `master` branch, you can [submit a compensation request](https://docs.bisq.network/dao/phase-zero.html#how-to-request-compensation) and earn BSQ (the Bisq DAO native token). Learn more about the Bisq DAO and BSQ [here](https://docs.bisq.network/dao/phase-zero.html). -# Further reading/other resources worth checking +## Further reading/other resources worth checking - tech session on [youtube](https://www.youtube.com/watch?v=ulmUVh3XjRg&list=PLFH5SztL5cYOtcg64PntHlbtLoiO3HAjB) - dev-calls on [youtube](https://www.youtube.com/watch?v=YnTA3p-5v00&list=PLFH5SztL5cYN1m9v_NvpXxvP7_XIKF3At) From c2fd63ebd39743b1e35e6c7113e39d71ad3cb677 Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Wed, 11 Dec 2019 12:13:14 +0100 Subject: [PATCH 6/7] Included review comments --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff92b7af76e..e5ef462c91b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ Java God, Bitcoin Native, Marketing Genius, Cypherpunk, Testing Machine, or simp The more correct way to see payment is "compensation". By earning BSQ, you invest in the Bisq project (just like other startups do it). But make no mistake, the DAO has only been operating for a few months now. Eventually, Bisq will create serious revenue. -**Tools?** If you want to develop code, we expect you to know your ways around Git and Java. Then comes testing, JavaFX, Gradle, Github, ... As for non-functional skills, we love to see people knowing their ways around P2P networks, cryptography, security, privacy, ... +**Skills?** If you want to develop code, we expect you to know your ways around Git and Java. Then comes testing, JavaFX, Gradle, Github, ... As for non-functional skills, we love to see people knowing their ways around P2P networks, cryptography, security, privacy, ... **Carreer?** Start small, go bigger. If we like your work, we might just ask you to take on a more official role. Maybe someday you are the guy improving this document (again). @@ -25,13 +25,13 @@ Still here? Nice. You are hired. On to the grind. ## Getting started -Join Gibhub if you haven't already, fork the Bisq repository, configure your local git ([username](https://help.github.com/articles/setting-your-username-in-git/), [commit signing](https://help.github.com/articles/signing-commits-with-gpg/)), clone your Bisq-fork to disk, do a compile run `./gradlew build`. +Join Gibhub if you haven't already, fork the Bisq repository, configure your local git ([username](https://help.github.com/articles/setting-your-username-in-git/), [commit signing](https://help.github.com/articles/signing-commits-with-gpg/)), clone your Bisq-fork to disk and do a compile run `./gradlew build`. -Now you are ready to roll. Pick something off the [Good First Issue List](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), pick any other issue, do some testing, spot a bug, report it and fix it, maybe there is something in the UI that needs cosmetic work. +Now you are ready to roll. Pick something off the [Good First Issue List](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), pick any other [issue](https://github.com/bisq-network/bisq/issues), do some testing, spot a bug, report it and fix it, maybe there is something in the UI that needs cosmetic work. The possibilities are endless. However, make sure the task you pick is of some importance, otherwise it might cause some inconvenience later on. -Now that you have picked yourself something to work on, be vocal about it! Claim good first issues, or any issues, by simply leaving a comment saying that this is being worked on, join [Keybase](https://keybase.io/team/bisq). Once there, introduce yourself in *#introductions*, get help in *#dev-onboarding* if your setup fights you, use *#dev* to see if the task you picked is a good way forward (you do not have to do that for good first issues) and join other channels if you want to. +Now that you have picked yourself something to work on, be vocal about it! Claim good first issues, or any issues, by simply leaving a comment saying that this is being worked on, join [Keybase](https://keybase.io/team/bisq). Once there, register your github with keybase, introduce yourself in the channel *#introductions*, get help in *#dev-onboarding* if your setup fights you, use *#dev* to see if the task you picked is a good way forward (you do not have to do that for good first issues though) and join other channels if you want to. Furthermore, check our [event calendar](https://bisq.network/calendar) and tune in on [dev-calls](hhttps://github.com/bisq-network/events/issues?q=Dev-Call), growth-calls and daily standup calls. -Go on and do the actual work. +Go on and do the actual work. And do not forget to enjoy yourself! ## Pull request rules @@ -42,7 +42,9 @@ Please honor the list of rules below for your pull request to get merged. Due to - Create a topic branch off master - Commit little, commit often - Maintain a clean commit history (no merges commits!, use rebase and force-push if necessary) - - Use meaningful commit subjects AND description (then, now, good, bad, risks) + - Use meaningful commit subjects AND description + - how did stuff work before you touched it, what has been bad back then + - how does the stuff work now and why is that better - Do so in a well-formed manner (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 From a8a89d9b348abf5b97b8602949d9f6d827ea54e8 Mon Sep 17 00:00:00 2001 From: Florian Reimair Date: Thu, 27 Feb 2020 12:20:49 +0100 Subject: [PATCH 7/7] Include review comments --- CONTRIBUTING.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5ef462c91b..708471a3bd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,14 +9,18 @@ Java God, Bitcoin Native, Marketing Genius, Cypherpunk, Testing Machine, or simp **What is there to work on?** You have to be able to find and work a problem on your own. In general, we do not assign stuff to people, there is no specification to be implemented, there is no given way forward. You yourself have to find, choose and pick something to work on. If you get stuck, we are keen to help, but please do not wait for us to take your hand. Also, you can spend as much (or little) time as you want and when you want to - Bisq still is an open source project. **Will you get paid?** Well, yes and no. With Bisq, there is no classic funding or investors, so there is no payout of fiat money. -- Yes, because there is the DAO. The DAO allows for compensation requests to be filed and voted on. If such a voting goes in your favor, you receive BSQ, a colored bitcoin token. Sell your BSQ and you get your fiat eventually. -- No, because the market is still very small. We can sustain a few full-timers (paying rent, tax, small stuff) but do not expect to get rich fast and easy just now. +- Yes, you can ask for compensation. If granted, you receive BSQ, a colored bitcoin token. Sell your BSQ and you get your fiat eventually. +- No, because the BSQ market is still bootstrapping. The more correct way to see payment is "compensation". By earning BSQ, you invest in the Bisq project (as you might in a more traditional startup). But make no mistake, the DAO has only been operating for a few months now. Over time, the BSQ market should be able to stay ahead of compensation requests. -The more correct way to see payment is "compensation". By earning BSQ, you invest in the Bisq project (just like other startups do it). But make no mistake, the DAO has only been operating for a few months now. Eventually, Bisq will create serious revenue. +**Skills?** +If you want to develop code, we expect you to know your ways around Git and Java. Then comes testing, JavaFX, Gradle, Github, ... If you want to do something else you are good at: marketing, user support, management process optimizations, you are most welcome as well! +If you are good at something Bisq does not even realize it is in need for, well, come on in! -**Skills?** If you want to develop code, we expect you to know your ways around Git and Java. Then comes testing, JavaFX, Gradle, Github, ... As for non-functional skills, we love to see people knowing their ways around P2P networks, cryptography, security, privacy, ... +**Carreer?** There is no boss in Bisq - there is only stakeholders. Stakeholders have invested their time, gained some experience with the project and thus, are granted influence on the project accordingly. As soon as you receive your first couple of BSQ, you are a stakeholder too. -**Carreer?** Start small, go bigger. If we like your work, we might just ask you to take on a more official role. Maybe someday you are the guy improving this document (again). +Start with something small, get yourself familiar with how things are done. Like it? Take on bigger tasks, be it development work, [roles](https://github.com/bisq-network/roles/issues) or other things you believe Bisq is in need for. + +All in all, there is no boss, there is no annual raise of salary, there is nobody to take your hand, there is just stakeholders and their passion for the Bisq project. @@ -27,7 +31,7 @@ Still here? Nice. You are hired. On to the grind. Join Gibhub if you haven't already, fork the Bisq repository, configure your local git ([username](https://help.github.com/articles/setting-your-username-in-git/), [commit signing](https://help.github.com/articles/signing-commits-with-gpg/)), clone your Bisq-fork to disk and do a compile run `./gradlew build`. -Now you are ready to roll. Pick something off the [Good First Issue List](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), pick any other [issue](https://github.com/bisq-network/bisq/issues), do some testing, spot a bug, report it and fix it, maybe there is something in the UI that needs cosmetic work. The possibilities are endless. However, make sure the task you pick is of some importance, otherwise it might cause some inconvenience later on. +Now you are ready to roll. Pick something off the [Good First Issue List](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3Ais%3Apriority), a [priority task](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or pick any other [issue](https://github.com/bisq-network/bisq/issues), do some testing, spot a bug, report it and fix it, maybe there is something in the UI that needs cosmetic work. The possibilities are endless. However, make sure the task you pick is of some importance, otherwise it might cause some inconvenience later on. Now that you have picked yourself something to work on, be vocal about it! Claim good first issues, or any issues, by simply leaving a comment saying that this is being worked on, join [Keybase](https://keybase.io/team/bisq). Once there, register your github with keybase, introduce yourself in the channel *#introductions*, get help in *#dev-onboarding* if your setup fights you, use *#dev* to see if the task you picked is a good way forward (you do not have to do that for good first issues though) and join other channels if you want to. Furthermore, check our [event calendar](https://bisq.network/calendar) and tune in on [dev-calls](hhttps://github.com/bisq-network/events/issues?q=Dev-Call), growth-calls and daily standup calls. @@ -41,7 +45,7 @@ Please honor the list of rules below for your pull request to get merged. Due to ### Honor Git best practice - Create a topic branch off master - Commit little, commit often - - Maintain a clean commit history (no merges commits!, use rebase and force-push if necessary) + - Maintain a clean commit history (no merge commits!, use rebase and force-push if necessary) - Use meaningful commit subjects AND description - how did stuff work before you touched it, what has been bad back then - how does the stuff work now and why is that better