Ubuntu

docstrings for snapcraft code

Task description:

  • git clone git@github.com:snapcore/snapcraft.git
  • Read HACKING.md to setup a virtual environment for development and testing
  • Pick a python module or package within the snapcraft directory
  • Create a branch -> git checkout -b my-branch
  • Add reST formatted docstrings, parseable by sphinx with as much linking as possible.
  • git add your module
  • git commit with an appropriate message as defined in CONTRIBUTING.md
  • push your branch to your repo
  • Create a pull request for review
  • Update with review comments

The task is considered done once it is merged into the master branch

Suggestions:

  • while this task could be done on any distribution or Linux OS variant, it will be more straightforward to do it on Ubuntu 16.04 LTS.

Task tags

  • python
  • snapcraft
  • sphinx
  • docstrings

Students who completed this task

Daniel Lim, Konrad Krawiec

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2017