Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.33 KB
Raw

Contributing

  1. Fork: https://github.com/eschweit-at-tibco/tci-elk-logging
  2. git clone <your fork address>
  3. cd <your local clone>
  4. Make changes
  5. Commit to your fork
  6. Send a Pull Request (PR)

How to contribute

This project accepts contributions via Github pull requests.

Getting started

  • Fork the repository on GitHub

Contribution flow

  • Create a topic branch from where you want to base your work (usually master).
  • Make commits.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to eschweit-at-tibco/mashery-oauth-demo .

Format of the Commit Message

We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why.

add the foo:bar shortcode

This adds a shortcode that shows foo to bar.

The format can be described more formally as follows:

<what changed>
<BLANK LINE>
<why this change was made>

The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.