livepeer / livepeer/go-livepeer

Enhancing Contribution Guidelines with Testing and Debugging Information

Open
#2,937 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

status: triage
Dominant language
Go
Stars
586
Forks
226
Avg merge
1d 17h
Merged PRs (30d)
19

Description

Feature Request: Enhancing Contribution Guidelines with Testing and Debugging Information

Is your feature request related to a problem? Please describe.

The current documentation for contributing to the project is comprehensive but could benefit from additional details regarding testing and debugging procedures. This will make it easier for potential contributors to understand the project's testing structure and debugging workflow, leading to more effective contributions.

Describe the solution you'd like

I propose enriching the Contribution Guidelines with the following additions:

  1. Testing Information:
  1. Debugging Information:
  • Introduce a section detailing how to set up and use Visual Studio Code (VSCode) for debugging within the project.
  • Utilize the guidelines provided in the vscode debugging notes by @eliteprox.

Describe alternatives you've considered

The alternative approach would be to create separate documents or markdown files for testing and debugging instructions or add these instructions to a developers section in the livepeer docs.

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository's contribution guidelines and review the linked PR comments and Goerli issue for the testing, orchestrator, testnet, and VSCode debugging details. Done means the guidelines explain these workflows clearly, including how to run tests with an orchestrator already using the required ports and how to request test LPT.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, vscode
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.