Skip to content

Development: Coding

Jump to bottom
Yu-Jie Lin edited this page Mar 2, 2018 · 3 revisions

Summary

  • All submitted changes are under the MIT License.

  • Atomic commit: One PR, One Commit, One Issue.

    • Proper PR title
    • Concise commit summary. Likely to be same as PR title, but more brief.
    • Detailed commit message body

  • Comment changes adequately.

  • Update the following files as needed:

    • README.rst (brief)
    • pipes.sh
    • pipes.sh.6 (detailed)

    The change for README.rst should be brief as it only is for a glance, but it has to be updated. As for the manpage, it must be updated thoroughly.

  • Tests using Bats

    • Write and update tests, see test/README for more information.
    • You can add Travis CI to your fork.
    • You can run make test to test locally.
Clone this wiki locally