Contributing - e-ucm/rage-analytics-tracker GitHub Wiki

Contributing to rage-analytics-tracker is easy:

Running & Testing

After forking the repository you must execute the following command: mvn clean install.

This will generate the necessary configuration files for running and testing the module.

You should take a look at a more detailed deployment guide.

API Changes & Additions

Don't forget to add the proper tests to the recent changes and additions. Our tests are located in /test folder of each module and are executed using Maven.

Keep in mind that rage-analytics-tracker is lincesed under the Apache 2.0 license before you decide to do code contributions.

Code Style

A few things we'd rather not like to see:

  • Underscores in any kind of identifier
  • Hungarian notation
  • Prefixes for fields or arguments
  • Curly braces on new lines

If you modify an existing file, follow the style of the code in there.

If you create a new Java class, please add at least some documentation that explains the usage and scope of the class. You can omit documentation for methods that are self-explanatory.

Git

Pull requests for the master repository will be checked by at least one core contributor before inclusion. We may reject your pull requests to master if we do not deem them to be ready or fitting. Please don't take offense in that case. We need to make sure things stay somewhat sane and stable.

rage-analytics-tracker uses a forked public project methodology. Here is a concise tutorial to help you get aquainted with the relevant Git commands for this project type.

Before you leave check out this Programming Best Practices Quotes for developers from around the web.