Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 1.85 KB

CONTRIBUTING.rst

File metadata and controls

78 lines (44 loc) · 1.85 KB
Raw

Contributing Guide

Contributions are welcome and greatly appreciated!

Workflow

A bug-fix or enhancement is delivered using a pull request. A good pull request should cover one bug-fix or enhancement feature. This ensures the change set is easier to review and less likely to need major re-work or even be rejected.

The workflow that developers typically use to fix a bug or add enhancements is as follows.

  • Fork the sdypy_template_project repo into your account.

  • Obtain the source by cloning it onto your development machine.

    $ git clone ttps://github.com/sdypy/sdypy_template_project.git
$ cd sdypy_template_project

  • Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  • Develop fix or enhancement:

    • Make a fix or enhancement (e.g. modify a class, method, function, module, etc).

    • Update an existing unit test or create a new unit test module to verify the change works as expected.

    • Run the test suite.

      $ pytest

  • The docs should be updated for anything but trivial bug fixes.

Perform docs check.

$ cd docs
$ make clean
$ make html

  • Commit and push changes to your fork.

    $ git add .
$ git commit -m "A detailed description of the changes."
$ git push origin name-of-your-bugfix-or-feature

    A pull request should preferably only have one commit upon the current master HEAD, (via rebases and squash).

  • Submit a pull request through the service website (e.g. Github, Gitlab).

  • Check automated continuous integration steps all pass. Fix any problems if necessary and update the pull request.