Skip to content

docs: update section around testing #4274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 1, 2021
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Sep 29, 2021

This PR adds more docs around our testing strategy including:

  • new section in MAINTAINING.md
  • new section for scripts in CONTRIBUTING.md

Fixes #4177

@jsjoeio jsjoeio added docs Documentation related testing Anything related to testing labels Sep 29, 2021
@jsjoeio jsjoeio self-assigned this Sep 29, 2021
@jsjoeio jsjoeio requested a review from a team as a code owner September 29, 2021 22:03
@codecov
Copy link

codecov bot commented Sep 29, 2021

Codecov Report

Merging #4274 (b9989ca) into main (1b80244) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4274   +/-   ##
=======================================
  Coverage   65.32%   65.32%           
=======================================
  Files          36       36           
  Lines        1883     1883           
  Branches      380      380           
=======================================
  Hits         1230     1230           
  Misses        555      555           
  Partials       98       98           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b80244...b9989ca. Read the comment docs.

@github-actions
Copy link

✨ Coder.com for PR #4274 deployed! It will be updated on every commit.

Copy link
Contributor

@greyscaled greyscaled left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♦️ Thanks for adding specific, concise instructions in MAINTAINING.md - it gives new and recurring contributors a very easy decision framework to work from, which makes the community more inclusive!

3. End-to-end tests
2. Script tests
3. Integration tests
4. End-to-end tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non-blocking(nice-to-have) it's typically less error-prone to just use 1. for all of them and let markdown convert them into 1 2 3 4 etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wish I could remember the point, but @code-asher mentioned a point against doing this so I haven't, but yeah, it probably is less error-prone!

Copy link
Member

@code-asher code-asher Oct 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahaha yeah because I read these raw in my editor and all I see is 1 1 1 11 1 1 1 1 1 1111 😛 So I always appreciate when the numbering is correct in the source ❤️

Really this should not be done manually, I would use a VS Code plugin or something to number them automatically.

@jsjoeio jsjoeio merged commit 4619786 into main Oct 1, 2021
@jsjoeio jsjoeio deleted the jsjoeio-testing-guidelines branch October 1, 2021 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related testing Anything related to testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add testing guidelines
3 participants