Skip to content

Bugs, Features & Branches

Steve Gifford edited this page Jan 2, 2016 · 1 revision

I'm borrowing this one from a few customers. Here's how we fix bugs and develop new features in WhirlyGlobe-Maply.

Bug Fixes

When working on a bug fix, make a new branch.

  • Name it bugfix/something-useful
  • Don't bother to include the Issue number unless you're feeling really OCD.
  • Push it while you're working on it. Doesn't need to compile.
  • When it's working, merge into develop or develop-version as appropriate
  • Run the full AutoTester suite after you merge, but before you push.

New Features

When working on a new feature, make a new branch.

  • Name it feature/something-useful
  • Push it while you're working on it. Doesn't need to compile.
  • Add a test for the new feature in the AutoTester app.
  • When it's working, merge into develop or develop-version as appropriate
  • Run the full AutoTester suite after you merge, but before you push.

Auto Tester

The AutoTester app is how we test things. You know, automatically. Or at least sort of automatically, but it's much better than what we had before.

For bug fixes, ask yourself the following.

  • Does this bug show up in one of the AutoTester tests?
  • If not, can you add a test that does show it?
  • Is that more trouble than it's worth? Discuss with Steve.