Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

98 lines (73 loc) · 3.9 KB
Raw

Contributing to yare

You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • If you're planning to implement a bigger feature it makes sense to discuss your changes first. Please create an issue and explain the intended change. This way you can make sure you're not wasting your time on something that isn't considered to be in yare scope.
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub.

Installation and setup

PC setup

  • Install latest JDK 8
  • Install Maven 3.3+
    • set system variable MAVEN_HOME to location of Maven root directory
    • set system variable MAVEN to %MAVEN_HOME%\bin
    • add %MAVEN% variable to system's PATH
  • Install Git and add bin directory to system's path
  • Install IDE of your choice

Project setup

Clone

To clone Yet Another Rules Engine please use command below:

git clone https://github.com/SabreOSS/yare.git

Build

To build Yet Another Rules Engine please use command below:

 mvn clean install

Making Changes

  • Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
  • Make commits of logical units.
  • Respect the original code style:
    • Only use spaces for indentation.
    • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
    • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests with mvn clean verify to assure nothing else was accidentally broken.

Submitting Changes

  • Sign the Contributor License Agreement if you haven't already.
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository.

Additional Resources