0xPolygon GitHub Template

This repo serves as a template for new repositories in the 0xPolygon organization.

Action Items

The following actions are required once you create a new repository from this repo:

• Update this README. Complete the sections to reflect your project
• Update CODEOWNERS file
• Update sonar-project.properties by adding your Sonar project key provided by the Security Team
• Update badges to reflect your project (badges are located at the bottom of this README)
• Ensure you are using Issue and PR Templates

About The Project

Built With

Getting Started

Local Development

• You can run locally against kurtosis-cdk environment using: docs/local_debug.md

Database

Installation

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples, and demos work well in this space. This is incredibly useful for support personnel when responding to issues related to your application.

Contributing

This is the place to document your delivery workflow. For example:

1. Clone the project
2. Create a feature branch beginning with the ticket number (git checkout -b INC-7689/update-readme)
3. Commit your changes (git commit -m 'Update README.me with default template)
4. Push to the branch (git push origin INC-7689/update-readme)
5. Open a Pull Request
6. After review and approval, changes are deployed immediately

Contact