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

[TASK] Cleanup and improvements #94

Closed
6 of 7 tasks
satyajeetkolhapure opened this issue Aug 23, 2023 · 1 comment · Fixed by #222
Closed
6 of 7 tasks

[TASK] Cleanup and improvements #94

satyajeetkolhapure opened this issue Aug 23, 2023 · 1 comment · Fixed by #222
Assignees
@alainncls
Milestone
MVP2

Comments

@satyajeetkolhapure
Copy link
Collaborator

satyajeetkolhapure commented Aug 23, 2023 •
edited by alainncls
Loading

  • Naming convention for test methods
  • Naming convention for private & internal variables & functions (cf. Solidity Style Guide)
  • Use MIT license tag in all solidity files
  • Add missing deployment scripts for any contracts if any
  • Add NatSpec comments where they're missing
  • Remove all import {Vm} in tests (as it's already imported through import {Test})
  • Linting warnings
@satyajeetkolhapure satyajeetkolhapure moved this from Draft to Ready for development in Verax Attestation Registry Aug 23, 2023
@satyajeetkolhapure satyajeetkolhapure self-assigned this Aug 23, 2023
@RitaO8 RitaO8 moved this from Ready for development to Next Milestone (MVP2) in Verax Attestation Registry Aug 31, 2023
@alainncls alainncls moved this from Next Milestone (MVP2) to Ready for development in Verax Attestation Registry Sep 5, 2023
@alainncls alainncls self-assigned this Sep 20, 2023
@alainncls alainncls moved this from Ready for development to In progress in Verax Attestation Registry Sep 20, 2023
@alainncls alainncls moved this from In progress to Peer-review in Verax Attestation Registry Sep 22, 2023
@alainncls
Copy link
Collaborator

Naming convention for private & internal variables & functions is not followed everywhere, we should rename them to start with a _, but doing so breaks the upgradeability (storage collision).
cf. #219
So we'll no cover this for the moment at least.

@alainncls alainncls mentioned this issue Sep 22, 2023
Merged
6 tasks
@alainncls alainncls moved this from Peer-review to Done in Verax Attestation Registry Sep 22, 2023
@alainncls alainncls added this to the MVP2 milestone Sep 26, 2023
@alainncls alainncls moved this from Done to Released in Verax Attestation Registry Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alainncls alainncls

Labels
None yet
Projects
Verax Attestation Registry
Status: Released
Milestone
MVP2
Development

Successfully merging a pull request may close this issue.

chore: Cleanup and improvements Consensys/linea-attestation-registry
2 participants
@alainncls @satyajeetkolhapure