Guidelines for pull requests

We ask that you please follow these guidelines when you make a pull request to Picard:

• Make your pull request against the latest master.
• Give your PR a concise yet descriptive title.
• Explain the change(s) you made clearly.
• Explain the motivation for making the change(s). What existing problem does the pull request solve?
• Mention any issues fixed, addressed or otherwise related to this pull request, including issue numbers or hard links for issues in other repos.
• Suggest a reviewer if you can.
• Respond promptly to review comments.
• Don't rebase or squash until you get final (thumbsup) from the reviewer(s).
• Once you get the final thumbs-up, please rebase your branch onto master, squash all commits and reword commit message to produce a single commit (exemptions may be made -- sparingly) that is uncluttered by excess lines (e.g. lines that just say "addressed review", "fixed" etc left over from squashing must be removed).

Example formatting of a good final commit message:

Write a short, descriptive and capitalized title

Start body after a blank line (critical; tools like rebase can get confused 
if you run the two together). Body contains more detailed explanatory 
text, if necessary. Further paragraphs come after blank lines. Wrap to
~72 characters if possible. 

    - Bullet points are okay, too  
    - Typically a hyphen or asterisk is used for the bullet, followed by a 
        single space, with blank lines in between, but conventions vary here  
    - Use a hanging indent