diff --git a/README.md b/README.md index 8115f8d..d7e7eda 100644 --- a/README.md +++ b/README.md @@ -46,4 +46,48 @@ MIT License --- +## 🤝 Contributing + +We welcome contributions to the MiniSudoku game! Here's how you can help: + +### Ways to Contribute +- **Game Features**: Add new Sudoku puzzles, difficulty levels, or gameplay modes +- **UI/UX Improvements**: Enhance the user interface, animations, or user experience +- **Smart Contract**: Improve gas optimization, add new features, or enhance security +- **Testing**: Add more comprehensive tests for contracts and frontend +- **Documentation**: Improve README, add tutorials, or create usage guides +- **Performance**: Optimize frontend performance or contract gas usage + +### Development Workflow +1. Fork the repository +2. Create a feature branch: `git checkout -b feature/your-feature-name` +3. Make your changes and ensure tests pass +4. Run the test suite: `npm run compile && npm test` +5. Submit a pull request with a clear description + +### Code Standards +- Follow existing code patterns and TypeScript/Solidity best practices +- Add tests for new functionality +- Update documentation for significant changes +- Ensure backward compatibility where possible + +### Smart Contract Guidelines +- Use OpenZeppelin contracts for security +- Add comprehensive test coverage +- Optimize for gas efficiency +- Include proper error handling + +### Frontend Guidelines +- Use TypeScript for type safety +- Follow React best practices +- Ensure mobile responsiveness +- Test on multiple wallet connections + +### Testing +- All smart contract functions should have unit tests +- Frontend should have integration tests +- Test on both testnet and mainnet + +--- + Built with ❤️ for the Farcaster community diff --git a/package.json b/package.json index 8791192..17cffe1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,8 @@ { "name": "minisudoku-game", "version": "1.0.0", + "description": "A competitive Sudoku game on Base chain as a Farcaster miniApp", + "author": "Adekunle Bamz", "private": true, "scripts": { "dev": "next dev", diff --git a/src/types/game.ts b/src/types/game.ts index 6193265..0927699 100644 --- a/src/types/game.ts +++ b/src/types/game.ts @@ -1,6 +1,4 @@ -import { SudokuGrid } from '../lib/sudoku'; - -export type Difficulty = 'easy' | 'medium' | 'hard'; +import { SudokuGrid, Difficulty } from '../lib/sudoku'; export interface GameSession { id: string;