Skip to content

Add a note to README about adding exclusions #89

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

Merged
aiman merged 1 commit into from
Sep 9, 2025
Merged

Add a note to README about adding exclusions #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@ The generated Python bindings include the contract ABIs as Python dictionaries.
If there is a new contract to include, add a new target to `Makefile` and a new
factory function to `autonity/factory.py` and `autonity/__init__.py`.

If an external/public function has an `only*` modifier that restricts usage by
end-users, then add an exclusion in the Makefile. Examples of such modifiers are
`onlyAutonity`, `onlyProtocol`, `onlyAccountability`, `onlyStabilizer`, etc.

## Contributing

To contribute a non-critical bug fix, please open a pull request against the
Expand Down
Loading