Skip to content

A few suggestions for general improvement #248

@scorpion9979

Description

@scorpion9979

Recently I had the pleasure of working on PR #246, which lead me to discover a few areas in the repo where improvements could be made:

  1. Lack of commit message linting: I noticed that most commit messages implement an emoji format, but once issue is that the format is not being enforced. I would suggest enforcing commit linting rules either via a Husky local development hook or via a GitHub Action. I would personally prefer using the Conventional Commit format with commitlint, but I think it should also be possible to configure commitlint to support the emoji commit message format.
  2. Apply a more standardized method of writing unit tests in both Foundry and Hardhat: Regarding Foundry, I personally prefer Sablier's test setup and conventions, which include the Branching Tree Technique. There's even a utility called Bulloak which enables converting written tree files into test boilerplate. This would make it easier for new developers to know the exact format of tests they are expected to deliver. It would also make it easier to spot and issues in tests if everyone was writing them using the same format.
  3. Clearer instructions for onboarding new developers: For example, I personally ran into an issue with starting a fork environment to be able to run the fork tests and ended up adding the line vm.createSelectFork locally in the setup phase of each fork test in order to run the tests successfully.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions