74 lines (54 loc) · 2.06 KB

Contributing to On-Chain FDIC Insurance DApp

Thank you for your interest in contributing to the On-Chain FDIC Insurance DApp! We welcome contributions from the community.

How to Contribute

Reporting Issues

Use the GitHub Issues page to report bugs using our issue templates
For security vulnerabilities, see SECURITY.md for private reporting
Clearly describe the issue including steps to reproduce
Include relevant logs, screenshots, and system information
Specify which component is affected (frontend, smart contracts, etc.)
Include network and wallet information if applicable

Suggesting Enhancements

Use GitHub Issues to suggest new features
Explain the use case and potential implementation
Discuss with maintainers before implementing major changes

Pull Requests

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Run tests and ensure everything passes
Commit your changes (git commit -m 'Add amazing feature')
Push to your branch (git push origin feature/amazing-feature)
Open a Pull Request

Development Setup

Clone the repository
Copy frontend/.env.example to frontend/.env and configure
Install dependencies:
```
npm install
cd frontend && npm install
```
Run the development server:
```
cd frontend && npm start
```

Code Style

Use consistent indentation (2 spaces for JavaScript/JSX)
Follow existing code patterns
Add comments for complex logic
Keep functions small and focused

Testing

Write tests for new features
Ensure all existing tests pass
Test manually on Sepolia testnet

Security

Never commit API keys or sensitive data
Report security vulnerabilities privately to maintainers
Follow smart contract best practices

Code of Conduct

Be respectful and inclusive
Welcome newcomers and help them get started
Focus on constructive criticism
Maintain a positive environment

Questions?

Feel free to open an issue for any questions about contributing.