Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (46 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 2.61 KB
Raw

Contributing to Word by Word Game

First off, thank you for considering contributing to Word by Word Game! Here's a simple guide to help you get started.

Please read our CODE_OF_CONDUCT.md before contributing.

How Can I Contribute?

Reporting Bugs

  1. Check if the bug has already been reported in the Issues section.
  2. If not, create a new issue. Be sure to include:
    • Platform (Linux,Android, iOS, Web)
    • Store (Google Play, Snapstore, ...)
    • Game version (for example 3.3.1+200) and device information
    • A clear title
    • A detailed description of the bug
    • Steps to reproduce the problem
    • What you expected to happen
    • What actually happened

Suggesting Enhancements

  1. Check if the enhancement has already been suggested in the Issues section.
  2. If not, create a new issue. Include:
    • A clear title
    • A detailed description of the proposed feature
    • Why you think this would be beneficial to the game

Contributing Code

  1. Fork the repository.
  2. Create a new branch for your feature: git checkout -b feature/your-feature-name
  3. Make your changes, following our coding standards (see below).
  4. Test your changes thoroughly.
  5. Commit your changes: git commit -m 'Add some feature'. Consider to use feat, fix, docs, style, refactor, test, chore or revert as the commit type. See more at Conventional Commits.
  6. Push to your branch: git push origin feature/your-feature-name
  7. Create a Pull Request (PR) to the main branch of the original repository.

Coding Standards

  • Follow Dart and Flutter best practices and the Effective Dart guide.
  • Use lint rules and autoformatting.
  • Use clear, descriptive variable and function names.
  • Comment your code where necessary.
  • Write tests for new features when possible.
  • Ensure your code passes all existing tests.

Setting Up Your Development Environment

  1. Install Flutter (version 3.24.2 or later).
  2. Install Dart (version 3.5.2 or later).
  3. Clone the repository: git clone https://github.com/xsoulspace/word_by_word_game.git
  4. Navigate to the project directory: cd word_by_word_game
  5. Install dependencies: flutter pub get
  6. Run the project: flutter run

Questions?

If you have any questions or need help, feel free to join our Discord community.

Thank you for your contribution! 🎈🌄