Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 1.44 KB
Raw

Contributing Guidelines

This document outlines the recommended way to contribute to Packages.

More information can be found in the project documentation.

Getting started

  1. Fork the Packages repository on GitHub.
  2. Clone your fork. 
    git clone [email protected]:yourname/packages
  3. Make your modifications, commit your changes, and push to your fork. 
    git add .
git commit -m "A short description about your changes"
git push origin master
  4. Open a Pull Request on the terramar-labs/packages GitHub repo.
  5. Be patient, but expect a response.
  6. Work with the project maintainers on any feedback or changes.
  7. Get your changes merged!

Other considerations

  • The master branch contains active development.
  • Create or a feature branch or don't-- whatever you prefer!
  • The project follows PSR-1, -2, and -4.
  • Consider writing unit tests for your change.

And don't be afraid to ask for help!

Open an issue if you're not sure about something. We're happy to discuss feature ideas and answer questions.

The project maintainers welcome any and all questions and feedback.

Open an Issue or email [email protected] to get in touch.