Skip to content
This repository has been archived by the owner on Nov 9, 2018. It is now read-only.

Latest commit

 

History

History
53 lines (40 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

53 lines (40 loc) · 2.57 KB
Raw

How to contribute

cslajs is developed and maintained by a global development team composed of volunteers. We welcome your help!

Getting started

  • Make sure you have a GitHub account
  • Review and follow the Coding standards we use to maintain consistent code in the framework
  • Submit a ticket for your issue, assuming one does not already exist
    • If you plan to hit an existing milestone make sure to set the milestone value in the issue so the team knows to expect the change
  • 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. Releases are typically in maintenance mode and accept only critical bug fixes. Check with the project owners before working on anything other than critical bug fixes.
    • Create a branch in which to do your work. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format.
    #99999 Make the example in CONTRIBUTING imperative and concrete

or

   Fixes #99999 Describe the change made in a concise manner
   Closes #9999 Describe the change made in a concise manner
  • Make sure you have added the necessary tests for your changes.

Submitting Changes

  • Print, sign, and email the contributor agreement document to Marimer LLC (rocky at lhotka dot net)
  • We will not accept large changes without a signed contributor agreement, but we may accept small edits to the existing codebase
  • By submitting a change, large or small, you grant ownership of the code and related IP to Marimer LLC, and you certify that you have the right to transfer such ownership
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the Marimer LLC organization.
  • Update your GitHub issue to mark that you have submitted code and are ready for it to be reviewed.
    • Include a link to the pull request in the ticket

Additional Resources