-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes in README.adoc #45
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated Intro
@csacher, this is looking great. A couple bits of feedback:
If you fail to do this, then the items all run together as seen below:
|
README.adoc
Outdated
= bisq network roles | ||
= Bisq Network Roles | ||
|
||
This repository gives you a transparent overview about all current roles within the Bisq Network. It provides the viewer with details about the purpose, motivation, privileges, requirements and responsibilities of all roles. This will ensure clarity about ones own role, help identifying other roles and facitilitate the compensation process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd yank the word 'transparent' here, sounds a little buzzwordy. Maybe just 'complete overview' instead.
- ones => one's
- typo in facilitate
README.adoc
Outdated
1. **Edit** Your Role according to the https://github.com/bisq-network/roles/blob/master/TEMPLATE.adoc[Template] | ||
1. **Propose** New File | ||
1. You're done? Then you are ready to Create a **Pull Request** | ||
1. Wait for Confirmation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can probably shorten this series of steps to:
How to create a new role
- Discuss and make sure there is consensus about the need for and purpose of this role in the #roles channel or elsewhere
- Create a GitHub issue representing that will be used to track this role (see other role issues for examples)
- Create and edit a 'specification' document for this role based on
ROLE-SPEC-TEMPLATE.adoc
. See the existing list of role specs and follow the naming convention. - Submit the new file as a pull request. Be sure to mention the role issue ID, e.g. Roles Maintainer #28 somewhere in the pull request title or description to ensure that the pull request shows up in the timeline of the role issue.
- The roles repository maintainer will review your new role spec, provide any feedback, and merge it when ready.
README.adoc
Outdated
|
||
This repository gives you a transparent overview about all current roles within the Bisq Network. It provides the viewer with details about the purpose, motivation, privileges, requirements and responsibilities of all roles. This will ensure clarity about ones own role, help identifying other roles and facitilitate the compensation process. | ||
|
||
The **owner of the role** is responsible for **creating and maintaining** of his/her **role description**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor edits:
The owner of [a given] role is responsible for creating and maintaining their role description as an AsciiDoc file here in this repository. We call these descriptions role specifications.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feedback implemented, table done, bonds according to spreadsheet (missing amounts for many roles)
This is merged, now, @csacher. Check out the changes at https://github.com/bisq-network/roles#readme, and I'd recommend browsing through the recent commits at https://github.com/bisq-network/roles/commits/master to see what changes were made and why. Thanks for the session today working on all of this! |
No description provided.