Frax Development Standards

General

Should utilize frax-template (opens in a new tab) and frax-standard-solidity (opens in a new tab) to speed up and normalize development.
Should pin dependencies to prevent breaks in future installs.

Should receive one explicit approval for low-risk PRs, at least two approvals otherwise to reduce errors and promote collaboration.
Should describe all notable changes within the description to support reviewers.
Should only apply one feature/change per PR to simplify reviews.
Should only contain commits by the author, unless a supporting PR is merged in, to prevent duplicate/overwritten work.

Should generate the msig tx where needed using SafeTxHelper (opens in a new tab), writing the tx to file, to provide replicable steps in msig operations.
Should use minimal hardcoded addresses to reduce possibility of wrong addresses.
Should use either a Constants file or dynamic loading (via contract calls) where possible.
Should define all variables as public to enable calling variables across tests.
Should have the script command commented above the script to easily replicate if needed.
Should have validation of state to further secure deployment.

Should incorporate the script to validate what is run.
Should validate what is not covered in the script, creating full coverage.
Should be pinned to a forked block unless the test contract is labeled Test_Fork_... to pass post-deployment.

Should contain an updated version(), ie. "1.1.0" to track current contract version.
Should inherit prior versions if possible to separate upgrade changes, simplifying reviews.
Should add state to upgradeable contracts through namespaced storage to protect state variables.
Should mark all functions as virtual to support potential future overrides.
Should inherit child contracts where possible to separate concerns.
Should utilize FraxUpgradeableProxy or FraxTransparentProxy from frax-standard-solidity to maintain proxy standards across the org.

Should enforce absolute file paths (eg. src/contracts/RemoteCustodianBase.sol instead of ../RemoteCustodianBase.sol) to reduce overhead when moving files.
Should balance simplicity with limited storage calls.