Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (48 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

79 lines (48 loc) · 2.25 KB

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project to grow.

If you haven't test the game yet, you can try it there.

Setup project

You need git, Java (JDK) 16 (or more) and Maven 3.6.3 (or more).

For apt package manager OS as Ubuntu or Debian:

sudo apt -y install git

sudo apt -y install maven

sudo apt -y install openjdk-17-jdk

For other OS, you will have some similar simple way to download this 3 tools (as .exe on Windows)

You can check your git, mvn, java & javac version by using :

git --version; java --version; javac --version; mvn --version

If maven is in version 3.6.3, you will need Java 16 insted of Java 17.

ps: some IDE provide git, Java & Maven.

Then you will need to clone the project:

git clone git@github.com:HydrolienF/Formiko.git

ps: If you haven't configure a key to connect your github account follow this tutorial

If you define MAVEN_OPTS somewere (.bashrc, .profile or else) you may need to remove it so that jvm.config can be used when launching projet. Execute 'export MAVEN_OPTS=""', to remove it temporary.

Compile & Run project

Compile code: mvn compile

Test code: mvn test

Launch game mvn exec:java

Launch game with args mvn exec:java -Dargs="$args1 $args2"

Submitting changes

Never push your commit directly to master. Push it to a new branch that will be merge in a version named branch (as 2.20).

Commit should look like this one : [#44] Remove moving glitch. A link to the connected issue & a small description of what you have done.

Coding conventions

All new classes names, functions names, vars names need to be in English.

Java basic naming conventions that you probably already know can be found here

In this project we have few more rules to shorter a bit code:

  • { Are at the end of the line.
  • getters & setters are write in 1 line.
  • tab are 2 spaces.
class C {
  private int max;
  public void function1(){
    System.out.println("Formiko !");
    max=10;
  }
  public int getMax(){return max;}
}