Skip to content

Latest commit

 

History

History
44 lines (38 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

44 lines (38 loc) · 2.5 KB

Contributing to Caldera Forms!

PHP Version

Caldera Forms supports PHP 5.6 or later.

Git Workflow

  • All commits should have a commit message that mentions an issue. (Include issue number in commit title #)
  • All commits should be made to a branch that is branched off of develop. There are two excpetions listed below.
    • The branch sould be named for the issue, using the form feature/<issue-number> where <issue-number> is the issue number.
  • We sometimes use a project branch for large projects.
    • The same branch naming rules apply.
    • Work for a feature or bug fix in a project is submitted as PR against the project branch.
  • When develop branch is being used for a major release, and a minor release must be developed, we use branch develop-minor.
    • The same branch naming rules apply.
    • Work for a feature or bug fix in a minor release is submitted as PR against the develop-minor branch.
    • After develop-minor is merged to master, then it will need to be merged to develop.
  • If a pull request is submitted against master branch, we will attempt to merge to develop.
    • Please do not submit pull requests against the master branch!

Step by Step

Submitting A Pull Request

  • Open Github issue explaining the reason for the change, if a corresponding issue does not already exist.
  • Fork Caldera Forms if you do not have permission to create a branch in Caldera Forms.
  • Make a branch from develop, call it feature/<issue-number> where <issue-number> is the issue number.
  • Write tests to prove new feature works or bug is resolved (not required if you don't work here.)
  • Commit the failing tests - including the commit number.
  • Push the branch to Github.
  • Open a PR to merge your branch to develop.
    • In the title, briefly summarize the change. Add a [WIP] prefix to title.
    • In the PR description, mention the issue number and describe what has changed.
  • Fix bug
    • Make incrimental commits.
    • Include issue number in each commit message
  • In the pull request, remove [WIP] from PR title.
  • Request a review from Josh (@Shelob9) or (@New0) of the PR.

PR Testing And Review

  • All PRs should be approved by Josh or Nico, which ever one didn't write the patch.
    • Christie can also merge to develop or master or grant others access.
  • PRs should only be merged once review is approved and tests are passing.

Release Flow

See internal documentation