Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.29 KB
Raw

Contributing to Web3 Protocol Security Library

We're excited that you're interested in contributing to SafeProtocol! Here's how you can help:

Adding a New Protocol

  1. Fork the repository and create a new branch for your contribution.
  2. Create a new JSON file in the appropriate network directory under src/.
  3. Fill in the protocol information following the data structure template.
  4. Ensure all contract addresses are checksummed and valid.
  5. Add any relevant security audit information if available.
  6. Submit a pull request with a clear description of your changes.

Updating Existing Protocol Information

  1. Fork the repository and create a new branch for your update.
  2. Locate the JSON file for the protocol you want to update.
  3. Make your changes, ensuring all information is accurate and up-to-date.
  4. If you're updating contract addresses, make sure they are checksummed and valid.
  5. Submit a pull request with a clear description of your changes and the reason for the update.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Questions?

If you have any questions or need further clarification, please open an issue in the repository.

Thank you for your contribution!