Skip to content

Add author and contributing #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AdekunleBamz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add author and contributing #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7deb62
Fix duplicate Difficulty type definition by importing from sudoku lib
Jan 17, 2026
a1a9c64
Add author field and comprehensive Contributing section to README
Jan 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 1 addition & 3 deletions src/types/game.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down