Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

107 lines (68 loc) · 3.43 KB

Contributing to DeWordle

Thank you for your interest in contributing to DeWordle! This guide will help you get started and while you are here do well to join our Telegram at DeWordle.

Important Note Before Applying 📝

⚠️ Avoid Generic Comments: Comments such as 🚫 "Can I help with this?" 🚫 "I’d love to contribute!" 🚫 "Check out my profile!" or 🚫 "Can I work on this?"... these will not be considered.

Instead, provide a clear explanation of your approach, which includes:

  • A brief introduction about yourself.
  • A concise plan outlining how you will address the issue (3–6 lines max).
  • Your estimated completion time (ETA).

What is DeWordle?

DeWordle is a decentralized, blockchain-based word-guessing game built on the StarkNet ecosystem. It merges the fun and challenge of Wordle with the transparency and security of blockchain technology.

Features

  • Daily Decentralized Word Challenges: A new word is generated every day and stored securely on-chain.
  • Transparent Gameplay: Game logic is stored on the blockchain, ensuring fair and verifiable outcomes.
  • Wallet Integration: Compatible with StarkNet wallets like Argent X for gameplay interactions.
  • On-Chain Rewards: Players earn tokens or NFTs for successful guesses or streaks.
  • Leaderboards: Track top players with a decentralized leaderboard.

How to Contribute🤝

Pull Request Template

To ensure consistency and improve the review process, we've implemented a PR template. When creating a pull request, please:

  1. Follow the PR template that automatically loads when you create a new PR.

  2. Fill out all relevant sections of the template.

  3. Ensure your PR description clearly communicates the changes you've made.

  4. Include screenshots or recordings when applicable.

  5. Link to any related issues using keywords like "Closes #123" or "Fixes #123"

The template location is at .github/PULL_REQUEST_TEMPLATE.md and provides a structured format to help maintainers understand and review your contribution more efficiently.

Steps to apply

  1. Apply for an Issue -Look for an open issue and comment expressing your interest in working on it. -Wait for the maintainer to assign the issue to you. -Remember to apply only if you can solve the issue. Again, In the comment, Add a quick introduction about yourself, The ETA, and how you plan to tackle the issue.

Setup Instructions

  1. Fork the repository.

  2. Clone your fork locally:

git clone https://github.com/your-username/dewordle.git
cd dewordle

  1. In your forked repo, Create a new branch:

    git checkout -b feature/your-feature-name

  2. Make your changes

  3. Commit with clear messages:

git commit -m "Add: brief description of changes"

  1. Push to your fork:

    git push origin feature-name

  2. Submit a Pull Request that properly describes your changes

Code of Conduct

  • Follow ethical coding practices.
  • Do not submit a Pull request unless you are assigned.
  • Tasks must be completed within the specified deadline.
  • Always reach out to the maintainer if you get stuck.
  • Ensure all tests pass.
  • Request reviews from maintainers, when you submit a PR.

License

This project is licensed under the MIT License.

Contact

For inquiries, reach out to us on Telegram at https://t.me/DeWordle.