Skip to content

Latest commit

Β 

History

History
82 lines (63 loc) Β· 3.35 KB

CONTRIBUTING.md

File metadata and controls

82 lines (63 loc) Β· 3.35 KB
Raw

π—™π˜‚π—» π—¦π—Έπ—Άπ—Ήπ—Ήπ˜€β„’ | Contribution Guidelines

Hey! What a pleasure you are contributing to our project. So that there are no problems and we can maintain a clean and efficient code , we ask that you follow the following guidelines:

Files β€’ Variables & Functions β€’ Comments β€’ Others

Files

In this project we are using two programming languages: Python and Java. Python is used for the implementation of the compiler because of its ease and the PLY library that helps a lot of the work. Java is used with Processing for the development of the games and their connection to the Kinect. We ask you to follow this and not put files in other programming languages.

Figure 1. Files allowed in funSkills

Variables and Functions

For the names of variables and functions please use underscore_case, the underscore version much easier to read. Python also takes this notation as its standard, and we adopt it the same for java programming. Take into account that the variables and functions should always start with a lowercase letter. And very important to use meaningful names.


Figure 2. Use undersocer_case

Note: For classes in Java, keep the given convention.

Comments

For comments we ask you to make a header in each file that follows the template we provide, this is to have a brief description of the file in addition to knowing the author. As for the comments of each function, we hope that they are the most possible, neither too simple nor too elaborate.

Header Template:
# ------------------------------------------------------------
# File: File.py|File.java
# Developed by: Names
# Project: FunSkills- [Compiler|Game]
# version: 0.0
# last edited by: Name:: hh.mm
#
# Description: A brief description of the code
#
# TEC 2019 | CE3104 - Lenguajes, Compiladores e Interpretes
# ------------------------------------------------------------

Other important things

In addition to the aforementioned, it is good that you consider the following aspects:

  • Make the modular code, don't make 'god files'
  • Do functions of considerable size. We don't want 1000 lines in a function!
  • If you consider it necessary, you can add to our documentation folder the papers and material necessary to give the greatest clarity to your code.