Skip to content

Latest commit

 

History

History
145 lines (105 loc) · 8.41 KB

CONTRIBUTING.md

File metadata and controls

145 lines (105 loc) · 8.41 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the GameZone repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the GameZone repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the GameZone repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the GameZone repository.

⭐️ Support the Project If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.

Issue Report Process 📌

  1. Go to the project's issues.
  2. Select the template that better fits your issue.
  3. Give proper description for the issues.
  4. Don't spam to get the assignment of the issue 😀.
  5. Wait for till someone is looking into it !.
  6. Start working on issue only after you got assigned that issue 🚀.

File naming conventions 📁

  • Give unique name for your game that don't exist already.
  • Folder naming convention
    • Game_Name ex. Tilting_Maze,Rock_Paper_Scissors (first letter should be capital and if you need space use underscore _ )
  • files in the folder
    • Main html file should be named as index.html , not something else like Tilting_Maze.html(Preferred)
    • Game files - index.html , script.js , style.css(not stictly to follow this but you should have separate file for each kind)
    • It is preferred if the main html file is directly added to the main folder of you game like Tilting_Maze/index.html along with other files like style.css, script.js
    • you can have other folders if you are having assets for your game
    • CreateREADME.md for your Game using this TEMPLATE.Although, it is not compulsory to follow this README template ,you can use your own README template whichever you prefer, to explain functionality and code of your Game
  • naming convention for the screenshot you will add in assets/images
    • Remember preview image should be in assets/images and not in main folder of Game itself.
    • Name of image should be same as your Game name
    • ex. Tilting_Maze.jpeg or .jpg or .png any of the image format, but don't add image format in the name itself , it is self-assigned to a image, you don't need to add it manually, otherwise it becomes Tilting_Maze.jpeg.jpeg
    • There should be only one ScreenShot of the game in assets/images and that too with same name as the Game (Exactly Same).
  • Note:-All Other data except the ScreenShot of your Game, should be in it's main folder , don't add it to other folders of the project.

---

Add Game to assets/js/gamesData.json

This guide will help you add your game to the main website.

  1. Locate gamesData.json: Go to the end of the gamesData.json file.

  2. Add Your Game Data: Append the following JSON entry at the end of the file:

    ,
"No.": {
    "gameTitle": "Title",
    "gameUrl": "Main Folder",
    "thumbnailUrl": "Preview Image"
}

    • No.: Replace No. with the next number in sequence. For example, if the last number in the file is 625, use 626 for your game.

    • Title: Replace "Title" with the title of your game as it should appear on the website. For example, if your game is named Super_Mario_Game, use "Super Mario Game".

    • Main Folder: Replace "Main Folder" with the path to your game's main HTML file. If index.html is directly in the game's folder, use the folder name (e.g., "Super_Mario_Game"). If index.html is in a subfolder, specify the path (e.g., "Super_Mario_Game/public"). If your main HTML file is not named index.html, include the file name (e.g., "Super_Mario_Game/mario.html" or "Super_Mario_Game/public/mario.html").

    • Preview Image: Replace "Preview Image" with the name of the image you added to the assets/images folder, including the file format. For example, "Super_Mario_Game.png" or "Super_Mario_Game.jpg".

  3. Important Notes:

    • Comma Placement: Ensure you add a comma before your new entry. This is crucial to maintain valid JSON format. The provided sample includes the comma, but make sure you don’t forget it.
    • Trailing Comma: JSON does not allow trailing commas. Do not add a comma after the last entry. Ensure your new game entry is added before the final closing curly brace of the file.
    • File Integrity: Do not modify any other part of the file. Only add your game entry at the end.

  4. Check if Game Load

    • Open index.html: After you have added your game to the gamesData.json open index.html of GameZone
    • Go To last Page: Go to the Last page and check if your game is loading along with preview image and when opened ,works properly.

## **Pull Request Process 🚀**
  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. You have added README file in your Game folder.
  4. You have added the thumbnail of the project/Game into assets/images for website preview
  5. Added your game screenshot in the assets folder by following the proper conversion specified over here
  6. You have added your game name and link in GameZone's README.md
  7. You have Added your game to assets\js\gamesData.json.
  8. you have reviewed that your Game loads on the website with preview image and works when opened.
  9. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Happy Hacking 💗