Enhancing Contribution Guidelines with Testing and Debugging Information

[rickstaa]

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:

• Include a new section explaining how to run tests and provide insights into the structure of test files.
• Include a section that explains how to run tests when you already have an orchestrator running on the required ports (see test: add LIVEPEER_HTTP_PORT test env variable #2936 (comment)).
• Include a new section explaining when and how to interact with the Goerli test net and how to request some test LPT (see Add arbitrum-one-goerli network and deprecate arbitrum-one-rinkeby #2664).

2. 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

[leszko]

@rickstaa thanks for raising the GH Issue. Would you be willing to fire a PR with the contributing doc improvements?

[rickstaa]

@rickstaa thanks for raising the GH Issue. Would you be willing to fire a PR with the contributing doc improvements?

Sure, no problem! Could you let me know where this information should be included? I'm relatively new to the project, so others might be better suited to create this PR. Nevertheless, I can create a pull request using the tools I'm familiar with and contribute to the repository. 👍🏻

[leszko]

I think https://github.com/livepeer/go-livepeer/blob/master/CONTRIBUTING.md is the right place.

[rickstaa]

I think https://github.com/livepeer/go-livepeer/blob/master/CONTRIBUTING.md is the right place.

Cool. Would you want the debugging and testing information to be included there or use links to separate README files?

[leszko]

I think that, unless we have a huge amount of content, then we can stick to one CONTRIBUTING.md page.