5c6a3df5bd
# Version 4.0.1 All tests were rewritten using hardhat instead of truffle for optimisation and improvements (tests now properly check revert messages and emitted events). # Update in contract source: - Compliance module view methods no longer require the modifier `onlyComplianceBound`. - Update to version `4.0.1` - `coverage` folder and `coverage.json` are now ignored. - Update module exports. - Action on push (link & tests) now runs coverage and uploads coverage results to action artifacts. - Action on pre-release and release now runs coverage and uploads coverage results to release artifacts. - Update the license note date to 2023 (previously 2022) - Remove migrations contract # Update documentation - README updated - CONTRIBUTING documentation added - WhitePaper pdf added - remove outdated documentation on transfers --------- Co-authored-by: Joachim <[email protected]>
2.3 KiB
Contributing to T-REX Protocol
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We Develop with Github
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests. Our test suite uses TypeScript and Hardhat.
- Ensure the test suite passes. Tests are automated and any PR will trigger them automatically.
- Make sure your code lints. We use Solhint for Solidity and ESLint for TypeScript.
- Issue that pull request!
Any contributions you make will be under the GPL v3 Software License
In short, when you submit code changes, your submissions are understood to be under the same GNU General Public License v3.0 that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Write bug reports with detail, background, and sample code
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
Use a Consistent Coding Style
We're using Solhint for Solidity and ESLint for TypeScript. Make sure your code follows the style guide.
Commit Messages
We encourage the use of Gitmoji for commit messages. It's a fun and easy way to identify the purpose or intent of a commit with a simple emoji.
License
By contributing, you agree that your contributions will be licensed under its GPL v3 License.