Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
47 lines (32 sloc) 1.79 KB

How to contribute

PDAL welcomes all contributions. We use Github's pull requests to accept patches from the community.

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • You usually should base your topic branch off of the master branch.
    • To quickly create a topic branch: git checkout -b my-topic-branch
  • Make commits of logical units.
  • 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 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 PDAL organization.
    • If your pull request fixes/references an issue, include that issue number in the pull request. For example:
Wiz the bang

Fixes #123.
  • PDAL developers will look at your patch and take an appropriate action.

Additional Resources

Acknowledgements

The basic skeleton of this CONTRIBUTING file was lifted directly from Puppet's.