Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.88 KB

CONTRIBUTING.textile

File metadata and controls

66 lines (45 loc) · 2.88 KB
Raw

How to contribute

TL;DR fork the project and send pull requests.

The following document explains how new changes should be made.

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Include steps to reproduce when it is a bug.
    • Include an example call and expected output when it is a feature request.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • To quickly create a topic branch based on master:
      • git checkout -b issueXYZ origin/master.
    • Please avoid working directly on the master branch.
  • Make commits of logical units.
  • If necessary rewrite the commit history before pushing changes.
  • Make sure your commit messages are in the proper format.
    • Use tools to help you write in the proper format (e.g. eGit )

(#99999) Make the example in CONTRIBUTING imperative and concrete.

Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.

The first line is a real life imperative statement with a ticket number
from our issue tracker. The body describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.

  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken:
    • mvn clean verify

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request.

Additional Resources

Setup

This project is using Clojure, Maven, Eclipse and Git as the main development tools. To build the project yourself just download & install at least Clojure 1.5 & Maven 3.0 and call mvn install inside the project folder. Maven should then proceed to clean, build, test, package and install this project.

Use the project import wizard from Eclipse to import this project. The integrated m2e-plugin will automatically setup the needed configuration files for Eclipse. If you are using an old version of Eclipse run mvn eclipse:eclipse first and then import this project into Eclipse.

Versioning

This project follows the semantic versioning guidelines.