Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (80 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

105 lines (80 loc) · 3.32 KB

Contributing Guidelines

Welcome to Memory Block Game! 🎉 We’re thrilled to have you contribute to this fun and interactive project. Whether you’re a beginner or an experienced developer, your contributions make a difference!

Eligibility Criteria 🚫

  • Ensure your contributions align with the project’s goals.
  • Star and Fork this repository.
  • Maintain the folder structure and file integrity.

Tasks 🌟

  1. Add or Improve Features:

    • Enhance the game mechanics.
    • Add new levels or blocks with creative logic.
    • Include comments in your code for clarity.

  2. Fix Bugs:

    • Identify and fix bugs in index.html, styles.css, or script.js.
    • Improve responsiveness or cross-browser compatibility.

  3. Enhance Visuals:

    • Update the design in styles.css for a better user experience.
    • Add animations or hover effects.

  1. Add New Functionality:

    • Include features like a timer or scoring system.
    • Implement levels of difficulty or additional gameplay modes.

  2. Optimize Performance:

    • Refactor existing code for efficiency.
    • Ensure the game runs smoothly on all modern browsers.

How to Contribute

1. Star this Repository

Click the ⭐ button to show your support!

2. Fork the Repository

Create your fork of the project.

3. Clone Your Fork

Clone the repository to your local machine:

git clone https://github.com/FOSSCLUB-LBSITW/Memory-block-game.git
cd Memory-block-game-main/code

4. Create a New Branch

Create a new branch for your changes:

git checkout -b <your_branch_name>

5. Make Changes

  • Add or edit files inside the /code directory:
    • index.html: For structural changes.
    • styles.css: For styling.
    • script.js: For logic.
    • images/: Add images for the blocks.

6. Stage and Commit Changes

Stage all changes and commit with a meaningful message:

git add -A
git commit -m "Add feature: Short description of changes"

7. Push Your Changes

Push your branch to your forked repository:

git push -u origin <your_branch_name>

8. Create a Pull Request

Go to the original repository and open a Pull Request.

  • Provide a clear description of your changes.
  • Attach screenshots or videos, if applicable.

Contribution Guidelines

  • Folder Structure: Keep all files in the code folder. 
     Memory-block-game-main/
    └── code/
        ├── index.html
        ├── styles.css
        ├── script.js
        ├── images/
        │   ├── img1.jpg
        │   ├── img2.jpg
        └── README.md
  • Code Quality: Follow clean and consistent formatting.
  • Commit Messages: Write clear, concise commit messages.

Congratulations! 🎉 You’re now a contributor to Memory Block Game!