Comments (4)
Purpose of Contributing Guide:
- Help Tessel users report, find, and fix bugs in software and hardware
- Guide people through the process of fixing open issues in software and hardware
- Bring people into existing RFC discussions and show them how to start their own RFCs
Assumptions of Contributing Guide:
- Reader has no previous experience in contributing to this or another open source project
- Reader has sufficient technical experience to contribute meaningfully
- Reader knows or knows how to look up any needed git functions
Does this cover it? Anything to add @johnnyman727 @tcr ?
from project.
Pulling in information from other relevant issues:
Part of the RFC discussion in #16 goes here.
@ekolker 's notes from #15 belong in this document more than the collaborator guide:
One possible workflow on the hardware side is below. I'm not married to it, but it should serve to start the conversation.
* Discussion and initial proposals happen on the forums, if only because GH issues are a little tougher to follow and higher barrier to entry for some people, especially hardware people.
* If the community thinks an idea sounds worth prototyping, a reasonable effort should be made to research what the requirements are and what specific solutions exist. A complete schematic and a "core" parts list are required to advance to the next step.
< Spilt between modules and Tessel platform hardware >
### Modules
* A first pass prototype of the hardware should be built and corresponding software (drivers) should be written.
* Once the prototype is completed, the candidate module should be put on the agenda for the next SC meeting by a Collaborator. Discussion topics:
* Is this something we should roll in as a first party module, or merely an addition to our third party library? Default to 3rd party.
* If the module will become a 1st party module, what constitutes reasonable reimbursement for the creator in terms of material prototyping costs?
* What budget, if any, shall be allocated for future development?
* If the concept is to become a first-party module (criteria include "will we sell more than 100 of these per year"?, "is this a problem we should be solving in hardware?", etc.), then the creator of the prototype is reimbursed for prototyping expenses immediately. If it is not to become a first party module, the creator shall not be reimbursed.
* If the hardware is to become a first party module, the SC and the community at large should continue discussion as to if the best possible solution has been chosen. Some combination of the SC member in charge of hardware and the OP will then work to develop the module.
### Tessel
* A proposal/spec should be submitted to the SC member responsible for hardware by a Collaborator in the form of an issue on the appropriate repo (presumably the v2 hardware repo?). Realistically, this proposal will be added to a list of RFCs for hardware to be considered...whenever it's time for new hardware, which is something the SC will presumably make a call on.
* When the time comes to develop new hardware, the SC will review the backlog of issues. The SC member in charge of hardware will work to integrate new features as per the result of the discussion.
...So that's a first pass anyway. Takeaways are
* Don't do it all on GH
* Reimbursements for work that becomes 1st party...but how much and *how* are still totally up in the air. I personally like a percentage cut of ongoing sales paired with reimbursement for material prototyping costs.
* SC decides if something enters the 1st party circle
from project.
A little late to the party, but if you check out the io.js contributing guide (vs their collaborating guide), they do have a brief CoC. Something to consider adding.
from project.
We have a CoC and I thought we had a link to it in the contributing guide but I don't see it now... thanks for bringing that up, def need to add that back in
from project.
Related Issues (20)
- SC Meeting for 2/12/18
- High five bot shouldn't assign the person who submitted the pull request as a reviewer
- Rework Readme HOT 7
- Change label "contribution-starter" to a GH-surfaced issue tag? HOT 3
- SC Meeting for Mon, Feb 12th, 2018 HOT 5
- SC Meeting for Mon, Feb 19th, 2018 HOT 1
- Tessel-highfive text thinks we're Rust
- Tesselcamp 2018
- Bocoup Foundation / Tessel Project Meeting Agenda
- Links in Readme goals/working group out of date
- SC Meeting for Mon, Feb 26th, 2018
- ECMAScript Version? HOT 2
- A beginners guide to using git HOT 2
- Reference article to rebase a PR
- Pay a consultancy to maintain? HOT 5
- https://tessel.io/ HTTPS certificate is expired HOT 1
- https://tessel.io/ HTTPS certificate is expired
- tessel.io is down HOT 1
- Slack invite link is not available!.
- discussion: current status of the project HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from project.