Skip to content

Instantly share code, notes, and snippets.

@abele

abele/CONTRIBUTING.rst

Created September 26, 2012 11:55
Show Gist options
  • Save abele/3787607 to your computer and use it in GitHub Desktop.
Save abele/3787607 to your computer and use it in GitHub Desktop.
Download ZIP
CONTRIBUTING draft
Raw
CONTRIBUTING.rst

How to contribute

Few guidelines for contributors to follow.

Getting Started

  • Make sure you have a GitHub account
  • 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

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git branch fix/master/my_contribution master then checkout the new branch with git checkout fix/master/my_contribution. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Check for unnecessary white-space with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
(#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.

Submitting Changes

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

Additional Resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment