Files
Fast-Export/.github/contributing.md
Frej Drejhammar 4227621eed Update contribution guidelines and make github display them
Try to make it clear that sloppy, throw it over the fence, patches
won't be accepted without revision and try to make sure a potential
contributor sees the warning while creating a pull request.
2021-07-29 15:28:01 +02:00

1.3 KiB

When submitting a patch make sure the commits in your pull request:

  • Have good commit messages

    Please read Chris Beams' blog post How to Write a Git Commit Message on how to write a good commit message. Although the article recommends at most 50 characters for the subject, up to 72 characters are frequently accepted for fast-export.

  • Adhere to good commit hygiene

    When developing a pull request for hg-fast-export, base your work on the current master branch and rebase your work if it no longer can be merged into the current master without conflicts. Never merge master into your development branch, rebase if your work needs updates from master.

    When a pull request is modified due to review feedback, please incorporate the changes into the proper commit. A good reference on how to modify history is in the Pro Git book, Section 7.6.

Please do not submit a pull request if you are not willing to spend the time required to address review comments or revise the patch until it follows the guidelines above. A take it or leave it approach to contributing wastes both your and the maintainer's time.