Skip to content
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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Dec 11, 2017
Merged

Changes in README.adoc #45

Changes from 3 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
eb56c95
Updated README.adoc
csacher Dec 6, 2017
332a866
Update README.adoc Link to Template
csacher Dec 6, 2017
ee99749
Update README.adoc
csacher Dec 6, 2017
e59fea7
Update README.adoc
csacher Dec 6, 2017
7e7386e
Update README.adoc
csacher Dec 6, 2017
b5a507e
Update README.adoc
csacher Dec 6, 2017
fa644a1
Added List of Roles
csacher Dec 6, 2017
2a9a341
Update README.adoc
csacher Dec 7, 2017
8bc9749
Update README.adoc
csacher Dec 7, 2017
37e8b73
Update README.doc
csacher Dec 7, 2017
d78ebcd
Update README.adoc
csacher Dec 7, 2017
0a8c312
Update README.adoc
csacher Dec 7, 2017
a3b3e93
Update README.adoc
csacher Dec 7, 2017
1e63fc6
Update README.adoc
csacher Dec 7, 2017
8c26d3a
Update README.adoc
csacher Dec 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
= 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.
Copy link
Contributor

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


The **owner of the role** is responsible for **creating and maintaining** of his/her **role description**.
Copy link
Contributor

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.


1. Create **New File**
1. **Name** Your File according to the defined syntax (eg. "role-maintainer.adoc")
1. **Edit** Your Role according to the https://github.com/bisq-network/roles/blob/master/README.adoc[Template]
1. **Propose** New File
1. You're done? Then you are ready to Create a **Pull Request**
1. Wait for Confirmation
Copy link
Contributor

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

  1. Discuss and make sure there is consensus about the need for and purpose of this role in the #roles channel or elsewhere
  2. Create a GitHub issue representing that will be used to track this role (see other role issues for examples)
  3. 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.
  4. 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.
  5. The roles repository maintainer will review your new role spec, provide any feedback, and merge it when ready.