Contributing doc change suggestions #17
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gretzke
commented
Jul 7, 2025
| ### Fix | ||
|
|
||
| Any bug fixes should be developed on a separate branch. The naming convention for these branches is `fix/*`. Once the fix is complete, a pull request into the dev branch can be created. | ||
|
|
Collaborator
Author
There was a problem hiding this comment.
Delete branching section
There was a problem hiding this comment.
I do think specifying WHEN we use dev branches would be nice, as we've started to introduce that into repos that have continual developments.
Also including a note that all deployed versions should be tagged
Collaborator
Author
There was a problem hiding this comment.
Added a release section, lmk if you want any additional information here.
| ### Best Practices | ||
|
|
||
| The [Forge Gas Snapshot](https://github.com/marktoda/forge-gas-snapshot) library is used to measure the gas cost of individual actions. To ensure that the measured gas is accurate, tests have to be run using the isolate argument to generate the correct snapshot and ensure that CI passes: | ||
| Best practices and naming conventions should be followed as outlined in the [Foundry Book](https://getfoundry.sh/forge/tests/overview). |
Collaborator
Author
There was a problem hiding this comment.
Foundrybook reference for testing best practices and naming conventions
gretzke
commented
Jul 7, 2025
CONTRIBUTING.md
Outdated
| ### Fix | ||
|
|
||
| Any bug fixes should be developed on a separate branch. The naming convention for these branches is `fix/*`. Once the fix is complete, a pull request into the dev branch can be created. | ||
| - The PR must be squash merged into a single commit |
Collaborator
Author
There was a problem hiding this comment.
PRs should be squash merged
gretzke
force-pushed
the
contributing/daniel
branch
from
04dd994 to
1c182ce
Compare
Closed
codyborn
approved these changes
Jul 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.