Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

66 lines (50 loc) · 2.98 KB
Raw

Contributing to Balloon Pop Game 🎈

Thank you for your interest in contributing to Balloon Pop! We appreciate any help to improve the game, whether by reporting issues, suggesting new features, or submitting pull requests. Please review the following guidelines to ensure a smooth collaboration.

Getting Started

Code of Conduct

Please read our Code of Conduct to understand the expected behavior when contributing to this project.

How to Contribute

  1. Fork the Repository: Click the "Fork" button on the repository's page to create a personal copy of the project.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/balloon-pop.git
  3. Set Up a New Branch: Make a branch for each new feature or bug fix. 
    git checkout -b feature/your-feature
  4. Install Dependencies: Ensure all dependencies are installed: 
    npm install

Types of Contributions

Reporting Issues

  • Search Existing Issues: Before creating a new issue, check if the issue already exists in the Issues tab.
  • Open a New Issue: Include a descriptive title, clear steps to reproduce the issue, and screenshots if applicable.

Suggesting Features

  • Feature Requests: If you have an idea to improve gameplay, make the game more engaging, or suggest new power-ups or levels, open a new issue and label it as "enhancement."
  • Customization Options: We welcome theme-based customizations or new sound effects. Share your ideas in an issue before submitting a pull request to ensure it's within the project scope.

Code Contributions

  1. Follow Coding Standards: Please write clean, readable code and follow best practices in JavaScript, React, and CSS.
  2. Documentation: Update relevant documentation if your change affects existing features.
  3. Write Meaningful Commit Messages: Use concise and descriptive messages, like fix: corrected balloon speed on level up or feat: added Halloween theme.
  4. Submit a Pull Request:
    • Push your branch: 
      git push origin feature/your-feature
    • Go to the repository on GitHub and open a pull request against the main branch.
    • Include a description of your changes and link any related issues.

Reviewing Code

  • Please feel free to review open pull requests and leave constructive feedback.

Additional Guidelines

Testing Your Changes

  • Test the game thoroughly to ensure it runs smoothly and doesn’t break existing features.
  • Confirm responsiveness across multiple devices and browsers.

Style Guide

  • JavaScript: Follow ES6+ syntax, ensure proper indentation, and use const or let where applicable.
  • CSS: Keep styles modular and use BEM naming conventions when applicable.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you again for helping to improve Balloon Pop Game! We’re excited to see your contributions. 🎉