warp icon indicating copy to clipboard operation
warp copied to clipboard

Improve documentation for testing

Open cicr99 opened this issue 2 years ago • 2 comments

There is a section in the readme (Testing for contributors) which has most of the commands for testing. This information should be added to the docs. Also, we should add tips to only run a subset of the tests, such as:

  • Run only semantic or behaviour test
  • Add a filter

cicr99 avatar Feb 11 '23 16:02 cicr99

Hi @cicr99, Can I work on this? Also, Can you provide resources from where I should learn more about them. and where exactly to make changes(links).

Looking forward for the reply!!😄

pranshu-taneja avatar Feb 14 '23 10:02 pranshu-taneja

Hi @pranshu-taneja, sure you can! Well, I explained how it works in this comment. More than that, there is this issue https://github.com/NethermindEth/warp/issues/875 that has more tips for devs on how to debug. Those should be added as well The idea is to create a section Testing your contribution (or something like that) in the documentation and add all of these information in there. The section should go here: https://nethermindeth.github.io/warp/docs/category/contribution-guidelines For that you'll need to modify the project here: https://github.com/NethermindEth/warp/tree/develop/docs/docs/contribution_guidelines Let us know if you need anything else

cicr99 avatar Feb 14 '23 15:02 cicr99