SubmittingPatches

1. summary How to submit a patch to backplanejs
2. labels Type-HowTo

Table of Contents Introduction Environment Branches Submitting a patch Incorporating the patch into backplanejs

Introduction

This page will describe how to submit a patch to backplanejs. However, for the time being I'm using it to keep my notes on how to incorporate changes from Anton and Frankie.

Environment

Each developer wishing to contribute patches should have their own clone of the backplanejs repo. This can be with any Mercurial provider, such as Google Code or Bitbucket. Please set the license to Apache.

In addition to installing Mercurial you will also need the pbranch extension.

Branches

The default branch should never be used for code changes, since it is used to keep the cloned repo in sync with the master repo at backplanejs.

All fixes and new features can be created as branches using `pbranch`. To keep synchronised, periodically `pull` from the master repo and use `pmerge` to bring any changes into the patch branches.

Any patch branch that is not dependent on another should be dependent on the default branch. This allows patches to be applied separately.

Submitting a patch

Details to follow.

Incorporating the patch into backplanejs

  # create a local copy of the developer's clone;
  # optionally, create an alias for the repo (e.g., `frankie` or `anton`);
  # do a pull from the remote clone into the local copy of the clone (`hg pull -R anton`);
  # import the revision required into the backplanejs patch queue (`hg export -R anton b30b992ee4 | hg qimport -n issue-92 -`).

To import a patch branch: