Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.97 KB

CONTRIBUTING_GUIDELINE.md

File metadata and controls

67 lines (47 loc) · 2.97 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:


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 is not already existed
  • Folder naming convention
    • Game_Name ex. Tilting_Maze (first letter should be capital and if you need space use _ )
  • files in the folder
    • index.html , script.js , style.css(not stictly to follow this but you should have separate )
    • you can have other folders if you are having assets for your game
    • README.md for your folder using template TEMPLATE
    • It is not compulsory to follow this README template only you can have your own
  • naming convention for the screenshot you will add in assets/images
    • name of image should be same as your game name
    • ex. Tilting_Maze.jpeg or .jpg or .png any of the image formate

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 repository .
  4. You have added the thumbnail of the project into assets/images for website preview
  5. Add 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 main README.md
  7. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Happy Hacking 💗