[Docs] Update `Quickstart` guide to onboard new devs - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev

MIT License

15 stars 6 forks source link

[Docs] Update `Quickstart` guide to onboard new devs #501

Closed Olshansk closed 1 month ago

Olshansk commented 2 months ago

Summary

Update the Quickstar guide to enable anyone to start developing on LocalNet quickly.

Issue

460

Type of change

Select one or more:

[ ] New feature, functionality or library
[ ] Bug fix
[ ] Code health or cleanup
[ ] Documentation
[ ] Other (specify)

Testing

Documentation changes (only if making doc changes)

[ ] make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

[ ] Unit Tests: make go_develop_and_test
[ ] LocalNet E2E Tests: make test_e2e
See quickstart guide for instructions

PR Testing (only if making code changes)

[ ] DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
- THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
- Optionally run make trigger_ci if you want to re-trigger tests without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as shown here

Sanity Checklist

[ ] I have tested my changes using the available tooling
[ ] I have commented my code
[ ] I have performed a self-review of my own code; both comments & source code
[ ] I create and reference any new tickets, if applicable
[ ] I have left TODOs throughout the codebase, if applicable

github-actions[bot] commented 1 month ago

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks. If you just created a pull request, you might need to push another commit to produce a container image DevNet can utilize to spin up infrastructure. You can use make trigger_ci to push an empty commit.