Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: add TESTING.md #847

Merged
merged 4 commits into from
Jan 15, 2024
Merged

docs: add TESTING.md #847

merged 4 commits into from
Jan 15, 2024

Conversation

YamenMerhi
Copy link
Member

@YamenMerhi YamenMerhi commented Jan 11, 2024 •
edited
Loading

What does this PR introduce?

📄 Documentation

PR Checklist

  • Wrote Tests
  • Wrote & Generated Documentation (readme/natspec/dodoc)
  • Ran npm run lint && npm run lint:solidity (solhint)
  • Ran npm run format (prettier)
  • Ran npm run build
  • Ran npm run test

@CJ42
Copy link
Member

CJ42 commented Jan 12, 2024

@skimaharvey @YamenMerhi Maybe we could also include in this document some overall idea of testing strategies for the LSPs? Like:

  • focusing first on unit tests, at the internal function levels with invariants and fuzzing.
  • then moving up towards integration and system tests, where different contracts and modules combined / linked together are tested.

Without going to thorough details, but to give an idea to external contributors too about the approach to provide when testing functionalities.

CJ42
CJ42 reviewed Jan 12, 2024
View reviewed changes
Copy link
Member

@CJ42 CJ42 left a comment

Choose a reason for hiding this comment

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

Great addition! Added review comments

TESTING.md Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
@CJ42 CJ42 merged commit def913d into develop Jan 15, 2024
24 checks passed
@CJ42 CJ42 deleted the TESTING.MD branch January 15, 2024 16:43
@richtera richtera mentioned this pull request Mar 6, 2024
Merged
6 tasks
richtera pushed a commit that referenced this pull request Mar 6, 2024
@YamenMerhi @CJ42 @richtera
docs: add TESTING.md (#847)
e5fa354 
* docs: add `TESTING.md`

* docs: remove duplicated code

* chore: add suggested changes

---------

Co-authored-by: Jean Cvllr <31145285+CJ42@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CJ42 CJ42 CJ42 approved these changes

@b00ste b00ste b00ste approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Addition of TESTING.md file
3 participants
@YamenMerhi @CJ42 @b00ste