Skip to content

Instantly share code, notes, and snippets.

View lilgallon's full-sized avatar
🇨🇵

Lilian Gallon lilgallon

🇨🇵
View GitHub Profile
@lilgallon
lilgallon / CONTRIBUTING.md
Created May 28, 2019 10:25
Contributing example for my projects

Contributing

When contributing to this repository, please make sure that the following rules are respected. If the rules are respected, you are free to change anything you want in the code ! Make a pull request and I will merge it - make sure to explain your changes ! :)

Coding style

  • Variables must be written using camelCase : thisIsMyVariable,
  • If an attribute or a variable is final, it should be written THIS_WAY,
  • Name the methods using camelCase as well : "itIsSomething()" and not this way "it_is_something()" ,
  • The getters must have "get" prefix, and then the exact name of the variable : "getHealth()" for "health",
  • If the variable is a boolean, then the getter should be written this way : "isAlive()" for "alive",
@lilgallon
lilgallon / CHANGELOG.md
Created May 28, 2019 10:14
Changelog template for my projects

Changelog

Legend :

❌ Removed | ✔️ Added | 💫 Fixed | ✨ Improved

Version -

  • ✔️ added ...
  • 💫 fixed ...
  • ✨ improved ...
  • ❌ removed ...
@lilgallon
lilgallon / README.md
Last active May 28, 2019 11:01
Readme template for my projects

CTRL+R:

  • -> repository name
  • N3RO -> github name
  • -> short description
  • -> name of the course
  • -> name of the university
  • -> grade of the project
  • CONTRIBUTING.md -> url to CONTRIBUTING.md
  • CHANGELOG.md -> url to CHANGELOG.md
  • -> license name