Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 4.22 KB

CONTRIBUTE.md

File metadata and controls

84 lines (69 loc) · 4.22 KB
Raw

Contributing to Klasemate

Great to have you here! We'd love for you to contribute to our source code, so here are a few ways you can help make Klasemate even better.

Issues and Bugs

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features by not reporting duplicate issues. Look at existing bugs and help us understand if "The bug is reproducible? Is it reproducible in other environments (browsers)? What are the steps to reproduce?".

Translations

You can help us translate our project creating new language packs or improving existing ones here: https://github.com/arcestiaishere/klasemate-languages.

In the future you will also be able to create customized themes.

Submitting a Pull Request

Before you submit your pull request, search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. As a contributor, you should always work on the development branch of your clone (master is used only for building releases).

  • Follow our Coding Guidelines
  • Make your changes in a new Git branch: git checkout -b bug-fix-branch development
  • Commit your changes using a descriptive commit message. Be clear and concise, since commits are used to help create changelogs.
  • Push your branch to GitHub: git push origin bug-fix-branch
  • In GitHub interface, send a pull request to klasemate:development
  • If we suggest changes then:
    • Make and commit the required updates. Try to understand the reasons explained by the team for the denial. Above all, please don't be offended.
    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request): git rebase development -i; git push origin bug-fix-branch -f

And that's all! :)

After your Pull Request is merged

Then you can safely delete your branch and pull the changes from the main (upstream) repository.

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: git push origin --delete bug-fix-branch
  • Check out the development branch: git checkout development -f
  • Delete the local branch: git branch -D my-fix-branch
  • Update your master with the latest upstream version.

Coding Guidelines

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • Never use short tags (<? or <?=$var?>), nor ASP-like tags; if a file is pure PHP code, omit the PHP closing tag at the end of the file (e.g. controllers).
  • Always add one space between operators (+, -, ++, --, ==, ===) and before curly braces.
  • Never use single quotes, except in:
    • Arrays indices: $array['index'];
    • HTML tags inside PHP strings: $link = "<a href='http://github.com'>GitHub</a>";.
  • K&R style: curly braces appears...
    • ...on new line:
      • Classes;
      • Functions.
    • ...on the same line:
      • Conditionals (if, else, switch);
      • Loops (while, foreach, for).
    • Never omit curly braces on if/else statements, and always use "uncuddled" else.
  • Casing:
    • UpperCamelCase:
      • Classes and methods: class Test and public function MyMethod().
    • separate_by_underscores:
      • Variables: $my_variable = false.
    • UPPERCASE:
      • Constants: define("SOME_VALUE", 1);
    • lowerCamelCase:
      • JavaScript functions and variables (*.js files only).
  • Always add the visibility of a property or a method (public, protected and private) and always explicitly declare public methods/properties.

Short example using some of these rules:

class MyClass
{
    public function MyFunction($some_value)
    {
        if($some_value == true) {
            echo "Value is true";
        }
        else {
            echo "Value is false";
        }
    }
}