Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 2.11 KB
Raw

How to contribute

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

You can contribute to this source code in many ways

  • You could report/fix a bug
  • You could suggest different words for the game
  • You could help to improve the UI of the game by either suggesting by images or directly editing the html/css files
  • You could suggest/implement a new feature/functionality
  • You could suggest improvements to the existing feature/functionality

Visit the ToDo page to see the potential features I have envisioned.

Guidelines for contribution

Did you find a bug?

Create an issue in this project with detailed information, screenshots (if possible, the console logs)

Do you want to suggest some new words for the game?

All the words for the game comes from this json file. You can edit this file directly (by forking) by clicking the pencil icon and propose the changes

Did you write a patch that addresses a bug?

Open a new GitHub pull request with the patch.

Do you intend to add a new feature or change an existing one?

  • Suggest your change by creating an issue with more information
  • Branch off from master
  • Start writing code
  • Open a pull request with the changes

About the teckstack of the project

  • NodeJS - For the backend
  • ExpressJS - As the web application framework to server the pages
  • Ejs - For templating
  • Socket.IO - For real time communication (used in chat and canvas synchronization)
  • HTML5, CSS3, JQuery

Follow the standards of respective technologies while contributing

Do you have questions about the source code or functionality?

Drop me a mail

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Thanks! ❤️ ❤️ ❤️

Ramaraj T