Skip to content

Commit

Permalink
Add initial release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
rlafuente committed Apr 28, 2018
1 parent 3548dd2 commit 21632d8
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions doc/source/developing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Developing

This section is for anyone who is interested in contributing to the codebase, or knowing more about the internals.


Coding style
------------

Expand All @@ -16,3 +17,29 @@ We try to have Shoebot examples follow this specification. Here are some of the
* Variables and functions are in ``lowercase`` and ``underscored_lowercase``, class names are in ``CamelCase``.

Be sure to read the full `PEP8 specification <http://legacy.python.org/dev/peps/pep-0008/>`_. When in doubt, be bold!


Making a release
----------------

This is our checklist to be sure we don't miss any detail when we put out a release.

* update the version number in these files:
- Makefile
- setup.py
- debian/files

* update the changelogs
- CHANGELOG
- debian/changelog

Building Debian packages
------------------------

There are some dependencies to look out for::

sudo apt-get install rename dh-python cdbs

Be sure to go through this checklist:

* update the debian/changelog file

0 comments on commit 21632d8

Please sign in to comment.