Difference between revisions of "Contributor checklist"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
<big>So you’re interested in contributing to Bisq, welcome! This checklist will get you plugged in and productive as quickly as possible.</big> | <big>So you’re interested in contributing to Bisq, welcome! This checklist will get you plugged in and productive as quickly as possible.</big> | ||
| − | == How to contribute == | + | == How to contribute == |
Bisq is free and open source software, but contributing is not just about writing code. '''A contributor is any individual who works to improve and add value to the Bisq Network and its users.''' | Bisq is free and open source software, but contributing is not just about writing code. '''A contributor is any individual who works to improve and add value to the Bisq Network and its users.''' | ||
| Line 7: | Line 7: | ||
This can mean anything from fixing typos in documentation, to answering questions on the Bisq Forum, to implementing new Bisq features and everything in-between. All such contributions are eligible for compensation under the Bisq DAO. See more details below and in the [[Compensation]] doc. | This can mean anything from fixing typos in documentation, to answering questions on the Bisq Forum, to implementing new Bisq features and everything in-between. All such contributions are eligible for compensation under the Bisq DAO. See more details below and in the [[Compensation]] doc. | ||
| − | === Getting started === | + | === Getting started === |
| − | # Join our [https://keybase.io/team/bisq Keybase team]. | + | # Join our [https://keybase.io/team/bisq Keybase team]. |
| − | # Introduce yourself in the <code>#introductions</code> channel. Say a bit about your skills and interests. This will help others point you in the right direction.https://bisq.wiki/Project_management | + | # Introduce yourself in the <code>#introductions</code> channel. Say a bit about your skills and interests. This will help others point you in the right direction.https://bisq.wiki/Project_management |
| − | # Explore the other channels on Keybase, and join the ones that are of interest to you. For a start, we recommend joining <code>#proposals</code>, <code>#growth</code>, <code>#roles</code>, <code>#compensation</code>, <code>#dev</code> and <code>#dev-onboarding</code> (if you’re a developer). | + | # Explore the other channels on Keybase, and join the ones that are of interest to you. For a start, we recommend joining <code>#proposals</code>, <code>#growth</code>, <code>#roles</code>, <code>#compensation</code>, <code>#dev</code> and <code>#dev-onboarding</code> (if you’re a developer). |
| − | # Watch the [https://github.com/bisq-network/proposals proposals], [https://github.com/bisq-network/roles roles] and [https://github.com/bisq-network/compensation compensation] repositories to get notified of threaded GitHub issue discussions that happen there. | + | # Watch the [https://github.com/bisq-network/proposals proposals], [https://github.com/bisq-network/roles roles] and [https://github.com/bisq-network/compensation compensation] repositories to get notified of threaded GitHub issue discussions that happen there. |
| − | # Read the [https://github.com/bisq-network/bisq/blob/master/docs/README.md developer docs] to set up a Bisq development environment. | + | # Read the [https://github.com/bisq-network/bisq/blob/master/docs/README.md developer docs] to set up a Bisq development environment. |
| − | # Read How to [https://chris.beams.io/posts/git-commit/ Write a Git Commit Message] and follow its [https://chris.beams.io/posts/git-commit/#7-rules 7 rules] when contributing to Bisq projects. | + | # Read How to [https://chris.beams.io/posts/git-commit/ Write a Git Commit Message] and follow its [https://chris.beams.io/posts/git-commit/#7-rules 7 rules] when contributing to Bisq projects. |
| − | # Get set up to [https://help.github.com/articles/signing-commits-using-gpg/ Sign your Git Commits] with GPG. | + | # Get set up to [https://help.github.com/articles/signing-commits-using-gpg/ Sign your Git Commits] with GPG. |
| − | === Learn how we work === | + | === Learn how we work === |
| − | # Read about [[Project_management|Bisq’s project management process]]. | + | # Read about [[Project_management|Bisq’s project management process]]. |
| − | # Familiarize yourself with [https://ossec-docs.readthedocs.io/en/latest/docs/development/oRFC/orfc-1.html C4: The Collective Code Construction Contract]. It’s a simple set of collaboration rules based on GitHub’s fork+pull request model, and a foundational part of how we work together. | + | # Familiarize yourself with [https://ossec-docs.readthedocs.io/en/latest/docs/development/oRFC/orfc-1.html C4: The Collective Code Construction Contract]. It’s a simple set of collaboration rules based on GitHub’s fork+pull request model, and a foundational part of how we work together. |
| − | # For more context on C4 and the principles behind it, read author Pieter Hintjens' short book, [https://www.gitbook.com/?utm_source=legacy&utm_medium=redirect&utm_campaign=close_legacy Social Architecture]. | + | # For more context on C4 and the principles behind it, read author Pieter Hintjens' short book, [https://www.gitbook.com/?utm_source=legacy&utm_medium=redirect&utm_campaign=close_legacy Social Architecture]. |
| − | # Introduce yourself to Bisq and the Bisq DAO with the [[Phase_zero|Phase Zero doc]]. It’s a bit outdated now, as the DAO has been launched, but it’s the best overview of Bisq’s background and underlying concepts. | + | # Introduce yourself to Bisq and the Bisq DAO with the [[Phase_zero|Phase Zero doc]]. It’s a bit outdated now, as the DAO has been launched, but it’s the best overview of Bisq’s background and underlying concepts. |
| − | # To understand Bisq’s commitment to radical transparency and radical honesty, read Part III of [https://www.amazon.com/Principles-Life-Work-Ray-Dalio/dp/1501124021/ Ray Dalio’s Principles]. | + | # To understand Bisq’s commitment to radical transparency and radical honesty, read Part III of [https://www.amazon.com/Principles-Life-Work-Ray-Dalio/dp/1501124021/ Ray Dalio’s Principles]. |
| − | # To get inspired about what building software in a non-hierarchical organization can be like (and what it requires of everyone involved), read the [https://steamcdn-a.akamaihd.net/apps/valve/Valve_NewEmployeeHandbook.pdf Valve Employee Handbook]. | + | # To get inspired about what building software in a non-hierarchical organization can be like (and what it requires of everyone involved), read the [https://steamcdn-a.akamaihd.net/apps/valve/Valve_NewEmployeeHandbook.pdf Valve Employee Handbook]. |
| − | === Get connected === | + | === Get connected === |
| − | # Subscribe to the [https://www.youtube.com/c/bisq-network Bisq YouTube channel] to get notified about every meeting we hold, tutorial we publish, live session we broadcast, and more. | + | # Subscribe to the [https://www.youtube.com/c/bisq-network Bisq YouTube channel] to get notified about every meeting we hold, tutorial we publish, live session we broadcast, and more. |
| − | # Follow [https://twitter.com/bisq_network @bisq_network] on Twitter. | + | # Follow [https://twitter.com/bisq_network @bisq_network] on Twitter. |
| − | # Catch up on past [https://www.youtube.com/playlist?list=PLFH5SztL5cYOtcg64PntHlbtLoiO3HAjB Bisq Tech Session] YouTube live streams. | + | # Catch up on past [https://www.youtube.com/playlist?list=PLFH5SztL5cYOtcg64PntHlbtLoiO3HAjB Bisq Tech Session] YouTube live streams. |
| − | # Subscribe to the [https://lists.bisq.network/listinfo/bisq-contrib bisq-contrib] mailing list for low-frequency, high-priority contributor communications. | + | # Subscribe to the [https://lists.bisq.network/listinfo/bisq-contrib bisq-contrib] mailing list for low-frequency, high-priority contributor communications. |
| − | === Get assigned to an issue or role === | + | === Get assigned to an issue or role === |
Discuss with others, and after it is agreed that someone will assign something to you, do the following: | Discuss with others, and after it is agreed that someone will assign something to you, do the following: | ||
| − | # Request an invite to the [https://github.com/bisq-network @bisq-network organization]. An admin will get you set up. Doing this makes it possible to add you to the [https://github.com/orgs/bisq-network/teams @bisq-network/contributors] team and to assign you to GitHub issues. | + | # Request an invite to the [https://github.com/bisq-network @bisq-network organization]. An admin will get you set up. Doing this makes it possible to add you to the [https://github.com/orgs/bisq-network/teams @bisq-network/contributors] team and to assign you to GitHub issues. |
| − | # After accepting your GitHub invitation, please change your [https://github.com/orgs/bisq-network/people membership visibility] from <code>private</code> to <code>public</code>. This helps others know at a glance roughly how many contributors are involved with Bisq. | + | # After accepting your GitHub invitation, please change your [https://github.com/orgs/bisq-network/people membership visibility] from <code>private</code> to <code>public</code>. This helps others know at a glance roughly how many contributors are involved with Bisq. |
| + | === Do valuable work and get compensated === | ||
| − | + | Ok. You’re all set up and ready to work. Here’s what to do next.</br></br> | |
| − | |||
| − | Ok. You’re all set up and ready to work. Here’s what to do next. | ||
# '''Find a problem somewhere in Bisq-land''' that (a) needs fixing and (b) is a match for your skills and interests. Browse critical bugs, open bounties, ask around about what other contributors think needs fixing. Because while you don’t need anybody’s permission and you can work on whatever you want, you’ll want to know up front whether anybody else is going to care about the work you do. | # '''Find a problem somewhere in Bisq-land''' that (a) needs fixing and (b) is a match for your skills and interests. Browse critical bugs, open bounties, ask around about what other contributors think needs fixing. Because while you don’t need anybody’s permission and you can work on whatever you want, you’ll want to know up front whether anybody else is going to care about the work you do. | ||
Revision as of 15:13, 22 September 2020
So you’re interested in contributing to Bisq, welcome! This checklist will get you plugged in and productive as quickly as possible.
Contents
How to contribute
Bisq is free and open source software, but contributing is not just about writing code. A contributor is any individual who works to improve and add value to the Bisq Network and its users.
This can mean anything from fixing typos in documentation, to answering questions on the Bisq Forum, to implementing new Bisq features and everything in-between. All such contributions are eligible for compensation under the Bisq DAO. See more details below and in the Compensation doc.
Getting started
- Join our Keybase team.
- Introduce yourself in the
#introductionschannel. Say a bit about your skills and interests. This will help others point you in the right direction.https://bisq.wiki/Project_management - Explore the other channels on Keybase, and join the ones that are of interest to you. For a start, we recommend joining
#proposals,#growth,#roles,#compensation,#devand#dev-onboarding(if you’re a developer). - Watch the proposals, roles and compensation repositories to get notified of threaded GitHub issue discussions that happen there.
- Read the developer docs to set up a Bisq development environment.
- Read How to Write a Git Commit Message and follow its 7 rules when contributing to Bisq projects.
- Get set up to Sign your Git Commits with GPG.
Learn how we work
- Read about Bisq’s project management process.
- Familiarize yourself with C4: The Collective Code Construction Contract. It’s a simple set of collaboration rules based on GitHub’s fork+pull request model, and a foundational part of how we work together.
- For more context on C4 and the principles behind it, read author Pieter Hintjens' short book, Social Architecture.
- Introduce yourself to Bisq and the Bisq DAO with the Phase Zero doc. It’s a bit outdated now, as the DAO has been launched, but it’s the best overview of Bisq’s background and underlying concepts.
- To understand Bisq’s commitment to radical transparency and radical honesty, read Part III of Ray Dalio’s Principles.
- To get inspired about what building software in a non-hierarchical organization can be like (and what it requires of everyone involved), read the Valve Employee Handbook.
Get connected
- Subscribe to the Bisq YouTube channel to get notified about every meeting we hold, tutorial we publish, live session we broadcast, and more.
- Follow @bisq_network on Twitter.
- Catch up on past Bisq Tech Session YouTube live streams.
- Subscribe to the bisq-contrib mailing list for low-frequency, high-priority contributor communications.
Get assigned to an issue or role
Discuss with others, and after it is agreed that someone will assign something to you, do the following:
- Request an invite to the @bisq-network organization. An admin will get you set up. Doing this makes it possible to add you to the @bisq-network/contributors team and to assign you to GitHub issues.
- After accepting your GitHub invitation, please change your membership visibility from
privatetopublic. This helps others know at a glance roughly how many contributors are involved with Bisq.
Do valuable work and get compensated
Ok. You’re all set up and ready to work. Here’s what to do next.
- Find a problem somewhere in Bisq-land that (a) needs fixing and (b) is a match for your skills and interests. Browse critical bugs, open bounties, ask around about what other contributors think needs fixing. Because while you don’t need anybody’s permission and you can work on whatever you want, you’ll want to know up front whether anybody else is going to care about the work you do.
