tessel / project

The open source Tessel Project. Start here!
https://tessel.io/
345 stars 69 forks source link

Contributing / getting help sections #3

Closed tcr closed 9 years ago

tcr commented 9 years ago

I'm a huge fan of Rust's distilled sections on this:

image

We can do something similar. AFAIK we have these assets

Frijol commented 9 years ago

Good idea– @johnnyman727 and I were discussing: better to separate out the contribution guide into a separate doc, or keep it in the main Readme?

Currently in the Readme because it's one of the first things people will want to know. However, I think the contribution guide will continuously expand, so might need its own Contributing.md and the Readme includes an exec summary of the project then links.

Personally I like a separate Contributing.md because a link in the fileviewer is highly visible/an obvious place to go if that's the info you're looking for

tcr commented 9 years ago

A simple proposal:


Community

Contributing

To contribute to the Tessel Project, see CONTRIBUTING.

tcr commented 9 years ago

Fixed by #23.