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.

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

[Feature]: Test Name Standardization #491

Open
1 task done
0xNeshi opened this issue Jan 13, 2025 · 2 comments · May be fixed by #504
Open
1 task done

[Feature]: Test Name Standardization #491

0xNeshi opened this issue Jan 13, 2025 · 2 comments · May be fixed by #504
Assignees
Labels
effort: medium Default level of effort. good first issue Good for newcomers. priority: 0 Nice-to-have. Willing to ship without this. type: ref A code update that doesn't meaningfully change functionality. type: test Changes to the testing suite.

Comments

@0xNeshi
Copy link
Collaborator

0xNeshi commented Jan 13, 2025

What is the feature you would like to see?

We agreed to standardize test function names (unit and e2e) in the following manner:

  • function_name_description for successful tests (e.g. fn mint_success, fn transfer_from_success_with_data).
  • function_name_revert_when_condition for tests expecting a revert (e.g. fn mint_reverts_when_receiver_is_invalid).

All test names in both unit and e2e tests should be updated to the new convention.

Related #386

Contribution Guidelines

  • I agree to follow this project's Contribution Guidelines
@0xNeshi 0xNeshi added priority: 0 Nice-to-have. Willing to ship without this. type: test Changes to the testing suite. good first issue Good for newcomers. effort: medium Default level of effort. type: ref A code update that doesn't meaningfully change functionality. labels Jan 13, 2025
@MukulKolpe
Copy link
Contributor

Hey @0xNeshi, can I work on this issue?

@0xNeshi
Copy link
Collaborator Author

0xNeshi commented Jan 15, 2025

Hi @MukulKolpe , thanks for taking an interest in contributing!

The issue is yours 👍

@bidzyyys bidzyyys added this to the Release v0.2.0 milestone Jan 15, 2025
@MukulKolpe MukulKolpe linked a pull request Jan 22, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium Default level of effort. good first issue Good for newcomers. priority: 0 Nice-to-have. Willing to ship without this. type: ref A code update that doesn't meaningfully change functionality. type: test Changes to the testing suite.
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

3 participants