Update docs and add new guides #284
Conversation
Signed-off-by: Nicko Guyer <[email protected]>
docs/contributors/contributors.md
Outdated
|
|
||
| To contribute to the repository, please [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) that you want to change. Then clone your fork locally on your machine and make your changes. As you commit your changes, push them to your fork. More information on making commits below. | ||
| ### Go experience | ||
| If you have some experience in Go and really want to jump into FireFly, the [FireFly Core](https://github.com/hyperledger/firefly/issues) |
There was a problem hiding this comment.
Feels like this sentence ended prematurely...
There was a problem hiding this comment.
Hah. I must have got distracted half way through writing that sentence. Not sure why the compiler didn't catch that...
docs/contributors/contributors.md
Outdated
|
|
||
| As with all Hyperledger repositories, FireFly requires proper sign-off on every commit that is merged into the `main` branch. The sign-off indicates that you certify the changes you are submitting in accordance with the [Developer Certificate of Origin](https://developercertificate.org/). To sign-off on your commit, you can use the `-s` flag when you commit changes. | ||
| ### React/TypeScript experience | ||
| If you want to do some frontend development, the [FireFly UI](https://github.com/hyperledger/firefly-ui/issues) is written in TypeScript and React |
There was a problem hiding this comment.
nit: period on the end of this
docs/contributors/contributors.md
Outdated
| If you want to do some frontend development, the [FireFly UI](https://github.com/hyperledger/firefly-ui/issues) is written in TypeScript and React | ||
|
|
||
| ### Go and blockchain experience | ||
| If you already have some experience with blockchain and want to work on some backend components, the blockchain connectors, [firefly-ethconnect](https://github.com/hyperledger/firefly-ethconnect/issues) (for Ethereum) and [firefly-fabconnect](https://github.com/hyperledger/firefly-fabconnect/issues) for Fabric are great places to get involved. |
There was a problem hiding this comment.
"for Fabric" should be in parens for consistency
|
|
||
| ### Installing GO and setting up your `GOPATH` | ||
|
|
||
| We recommend following the [instructions on golang.org](https://golang.org/doc/install) to install Go, rather than installing Go from another package magager such as `brew`. Although it is possible to install Go any way you'd like, setting up your `GOPATH` may be differ from the following instructions. |
There was a problem hiding this comment.
"may differ" (instead of "may be differ")
|
|
||
| ## Table of contents | ||
|
|
||
| {: .no_toc .text-delta } |
There was a problem hiding this comment.
When looking at your preview of the rendered docs, the TOC for this page is a totally different font from the rest of the pages.
There was a problem hiding this comment.
It's that line of whitespace between the header and the next line. So strange. Good catch, thanks.
awrichar
left a comment
There was a problem hiding this comment.
Noted a few very minor typos and observations. Looks great overall!
Signed-off-by: Nicko Guyer <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #284 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 225 225
Lines 12406 12410 +4
=========================================
+ Hits 12406 12410 +4
Continue to review full report at Codecov.
|
The Contributor's Guide has seen some meaningful updates in this PR. There are some additional, brand new guides added here too.
Relevant changes can be previewed here: