There are many ways to contribute to CMTAT Contracts.
If you want to propose some improvement to CMTAT codebase, use the current development branch dev to perform the modification.
For big change or experimental features, we recommend to create a dedicated repository and use CMTAT as a github submodule.
git submodule add https://github.com/CMTA/CMTATYou can find example of using CMTAT as a github submodule in following repositories: SnapshotEngine or CMTAT Factory
If you want to use CMTAT, we recommend to use CMTAT as a library through GitHub submodule instead of a fork
This would make it easier to keep your changes separate from the upstream CMTAT codebase.
It also simplifies upgrading to newer versions of CMTAT, since updating a submodule is typically cleaner and more straightforward than maintaining a fork.
You can [open an issue] to suggest a feature, a difficulty you have or report a minor bug. For serious bugs in an audited version please do not open an issue, instead refer to our [security policy] for appropriate steps. See SECURITY.md.
Before opening an issue, be sure to search through the existing open and closed issues, and consider posting a comment in one of those instead.
When requesting a new feature, include as many details as you can, especially around the use cases that motivate it.
If you would like to contribute code or documentation you may do so by forking the repository and submitting a pull request.
Run linter and tests to make sure your pull request is good before submitting it.
Based on the version made by OpenZeppelin