-
Notifications
You must be signed in to change notification settings - Fork 18
docs: add readme with links to community docs #4 #6
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 from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # Bitcoin Design Projects | ||
|
|
||
| We need a system that allows us to organize and communicate active design projects. The system should make it easy for someone to quickly glance at active projects and be able to participate in a project of interest without wading through irrelevant discussion. The system should also be as decentralized as possible, allowing anyone to formulate an idea, turn it into a concept, then a proposal, and begin working on it. | ||
|
|
||
| This document is about larger contributions to Bitcoin Design that may involve multiple contributors over days, weeks, and months. Smaller requests and improvements (fixing typos, updating an image, bugs) can more simply get handled via issues. | ||
|
|
||
| An active project board can be used to help organize these efforts. We are proposing that this could live on a community Github account, but before that is set up this doc is meant to be an overview of what is being worked on. | ||
|
|
||
| This is an early doc with a list of active projects, how to initiate one and how to run a project once live. These are proposals and can be adjusted as needed based on feedback. Please be vocal about your concerns. | ||
|
|
||
| ## Project Life Cycle | ||
|
|
||
| ```mermaid | ||
| graph LR | ||
| Idea --> Concept --> Proposal --> Active --> Completed | ||
| ``` | ||
|
|
||
| Many projects start as simple ideas and grow over time with the help of many different people. Ideas can be about new chapters to the guide, new work groups, research projects, software to be developed, contributions to other projects, and more. | ||
|
|
||
| ### 1. Idea | ||
|
|
||
| - Formulate your idea and discuss it on Slack (#project-ideas) to get feedback | ||
| - References, prototypes, sketches and other materials that help explain the idea are great for communicating clearly | ||
| - An idea does not have to be so specific that the outcome is clear | ||
|
|
||
| ### 2. Concept | ||
|
|
||
| - A more mature idea can be posted as an issue on GitHub (in the most appropriate repository and project board) after some discussion | ||
| - We may want to create an issue template to help people enter at least the minimum information needed for others to understand and evaluate the concept | ||
| - The concept can be fleshed out further in the comment thread of the issue | ||
| - The issue becomes the central place for the concept (unlike Slack where things get lost in the feed) | ||
|
|
||
| ### 3. Proposal | ||
|
|
||
| - Goal of a proposal is to decide what to practically do about it, turning a concept into a plan | ||
| - Anybody can turn a concept into a proposal if they feel it is worthwhile to continue with it | ||
|
|
||
| ### 4. Active Project | ||
|
|
||
| - A proposal becomes an active project once there is enough support and people actively start working on it | ||
| - If the project is related to the code on GitHub, a branch or fork can be created for the work to be executed | ||
| - If needed, a new repository and/or project board can be set up | ||
|
|
||
| ### 5. Completed project | ||
|
|
||
| - If the project is in a branch or fork, a pull request is created | ||
| - This pull request needs to be reviewed | ||
| - Support and concerns are shown via comments that contain our approval term (ACK, W, thumbs up, etc) or disapproval term (NACK, L, thumbs down, etc) and a rationale. | ||
| - Comments are primarily weighted based on the strength of the rationale, but may also be weighted based on expertise, commitment and consistency of the commenter to the project. | ||
| - Concerns need to be adequately addressed (note this is different than resolved) by participants before moving forward. | ||
| - A rough consensus should be reached before continuing | ||
| - For a thoughtful explanation of rough consensus, please [read this](https://tools.ietf.org/html/rfc7282). | ||
| - On completion, the pull requests is merged and closed, along with the issue | ||
| - Need to decide initial group of maintainers with merge access, [join the discussion](https://github.com/BitcoinDesign/Meta/issues/10) | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,30 @@ | ||
| # Bitcoin Design - Meta | ||
| `community`, `project-management`, `process` | ||
| `community`, `project-management`, `process` | ||
|
|
||
| Anything related to group consensus and coordination of the Bitcoin Design Community. | ||
|
|
||
| ### Getting Started | ||
| 1. Pick existing [project](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit) in the space and do something small | ||
| 2. If you are passionate. Just do it. Worst case you publish it on your own | ||
| 3. Contribute to parts of the design guide and website even if it is a slower process to get things approved | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO we should remove negative language like "even if it is a slower process" ... let's be optimistic when introducing new people to the project :) |
||
| ### Projects | ||
|
|
||
| - Project list — [Doc](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit) | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same comment as above - need to point to github not google docs |
||
| ### Governance / Opensource Design | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe use softer language "process" vs. "governance"? |
||
| - Slack Channel — [#open-design](https://bitcoindesign.slack.com/archives/C015GFYSJNA) | ||
| - Discussions -- [Issues](https://github.com/BitcoinDesign/Meta/issues) | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. seems like the project lifecycle in the google doc should be placed in markdown on github and then pointed to as part of "governance" (or, process) |
||
| ### Research | ||
|
|
||
| - Slack Channel — [#research](https://bitcoindesign.slack.com/archives/C015DQEPCHJ) | ||
| - User Surveys — [WIP Doc](https://docs.google.com/document/d/1Sjh9yZJOHfbrqmjpdiekDz361A9kWEsDrB0CggIoxU0/edit#) | ||
|
|
||
| ### Guide | ||
|
|
||
| - Project Intro — [Doc v2.0.0](https://docs.google.com/document/d/1YiYeRIybGmxmErCOI4Jc8Qajz3JGM1JYVfUtpzyCzSk/edit?usp=sharing) | ||
| - Slack Channel — [#bitcoin-design-guide](https://bitcoindesign.slack.com/archives/C015856BDME) | ||
| - Github Repository — [guide](https://github.com/BitcoinDesign/Guide) | ||
| - Github Project Board — [guide/content](https://github.com/BitcoinDesign/Guide/projects/1) | ||
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.
My understanding of our process is that we'll use GitHub Projects, so the link should point to the list of active projects on GitHub not a Google doc
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.
From the google doc