Skip to content

Add author and contributing#4

Open
AdekunleBamz wants to merge 2 commits intophessophissy:mainfrom
AdekunleBamz:add-author-and-contributing
Open

Add author and contributing#4
AdekunleBamz wants to merge 2 commits intophessophissy:mainfrom
AdekunleBamz:add-author-and-contributing

Conversation

@AdekunleBamz
Copy link

Description

Enhanced the MiniSudoko project with metadata and contributor guidance by:

  1. Added author field to package.json for proper attribution
  2. Added description field to package.json for better npm registry presentation
  3. Added comprehensive Contributing section to README with detailed guidelines for contributors including:
    • Ways to contribute (game features, UI/UX improvements, smart contract enhancements, testing, documentation, performance)
    • Development workflow with clear step-by-step instructions
    • Code standards and best practices for both Solidity and TypeScript
    • Specific guidelines for smart contract and frontend development
    • Testing requirements and standards

Changes Made

  • package.json: Added "author": "Adekunle Bamz" and "description": "A competitive Sudoku game on Base chain as a Farcaster miniApp" fields
  • README.md: Added comprehensive Contributing section with:
    • Multiple contribution categories
    • Structured development workflow
    • Code standards for Solidity and TypeScript
    • Smart contract and frontend specific guidelines
    • Testing requirements

Type of Change

  • Documentation update

Testing

  • Verified package.json parses correctly with new fields
  • Ensured README renders properly with proper markdown formatting
  • Confirmed all links and formatting are consistent with existing documentation

Additional Notes

This contribution significantly improves the MiniSudoko project's openness to contributors by:

  1. Proper Attribution: Adding author field provides proper credit and ownership
  2. Enhanced Package Metadata: Better npm registry presentation with description
  3. Comprehensive Contributing Guidelines: Clear instructions for potential contributors on how to help with this competitive Sudoku game
  4. Development Standards: Established coding standards for both smart contract and frontend development
  5. Testing Requirements: Clear expectations for code quality and testing

The additions make this Farcaster miniApp project more accessible to the open-source community and provide clear pathways for contributors to help improve this innovative competitive gaming experience on Base.

@vercel
Copy link
Contributor

vercel bot commented Jan 18, 2026

Someone is attempting to deploy a commit to the phessophissy's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant