docs: Update contributing guide #3202
Conversation
…nd fuel-core functionality
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
@richardgreg is attempting to deploy a commit to the Fuel Labs Team on Vercel. A member of the Team first needs to authorize it. |
CodSpeed Performance ReportMerging #3202 will improve performances by ×3.4Comparing Summary
Benchmarks breakdown
|
richardgreg
requested review from
digorithm,
arboleya,
Torres-ssf,
Dhaiwat10,
danielbate,
nedsalk,
petertonysmith94 and
maschad
as code owners
There was a problem hiding this comment.
@richardgreg Absolutely great work as usual, couple comments, also we need to change the base branch from master to next. Thanks for the contribution, much appreciated.
Also when using the standard binaries again (via versions), I've experienced issues in the past where it uses the previously downloaded binaries. Maybe we could add something on this, saying that they can delete the downloaded repositories to resolve this.
Forc: internal/forc/sway-repo
Fuel-core: internal/fuel-core/fuel-core-repo
CONTRIBUTING.md
Outdated
| ```bash | ||
| git:some/branch-name | ||
| ``` |
There was a problem hiding this comment.
(Can't suggest this change via GH)
Un-needed whitespace, and this isn't a bash file. (not 100% it's a txt file either, but seems more appropriate)
Same goes for all the below snippets :)
There was a problem hiding this comment.
The blank space is there because I followed a Markdown linting rule 🙂
There was a problem hiding this comment.
Well now I've learn't something.
There was a problem hiding this comment.
Just so you know, this is an example of what the contributing file will look like if I completely applied the linting rule. It follows a format where only the top-level header uses a single hash sign. Then, the subsequent subheadings use two hash signs. If a subheading has a child subheading, it uses three. You get the gist.
I can include the change if you like the style. But if you prefer the current style, I can leave it as it is.
• Added note on what files are created after intalling `forc` and `fuel-core` • Added a note that resolves the issue that arises when using standard binaries but it uses the previously downloaded binaries.
richardgreg
force-pushed
the
richardgreg/docs/contributing-giude-update
branch
from
5b53fab to
22264d2
Compare
|
Converting this to a draft until all resolved @richardgreg |
| pnpm build | ||
| ``` | ||
|
|
||
| The following directory will be updated or created: `internal/forc/sway-repo` |
There was a problem hiding this comment.
@petertonysmith94 I added the note about the files created here. Would you prefer it to be a separate section?
There was a problem hiding this comment.
I think adding it as a [!NOTE] would be enough. Maybe worth just adding something on what these directories contain :)
|
|
||
| The following directory will be updated or created: `internal/fuel-core/fuel-core-repo` | ||
|
|
||
| # Switching Back to Standard Binaries |
There was a problem hiding this comment.
Here's the whole section on fixing the problem of the program using a previously downloaded binary
|
Hi @petertonysmith94, sorry about the delay, had to take care of a personal errand. I've added the note but noticed the |
Summary
Updated contributing guide on how to work with unreleased
forcandfuel-corefunctionality.Another goal is to document how to turn e2es for devnet on and off
Checklist