Skip to content

Commit

Permalink
Updated development_workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
unoebauer committed May 11, 2016
1 parent 2eb25d6 commit ee91db2
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions docs/workflow/development_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@
Developer Workflow
******************

Many of the Development workflow is taken from `Astropy <http://docs.astropy.org
If you want to contribute to the development of TARDIS, please read through
this page and follow the guidelines outlined here. Many of the Development
workflow is taken from `Astropy <http://docs.astropy.org
/en/stable/development/workflow/development_workflow.html>`_ and credit belongs
to the Astropy team for designing it.

The first step is to setup up a python environment. :doc:`python_environment`
explains how to do that.
Preparation and Working with Git
================================

:doc:`git_workflow` describes how to interact with git and github in the development
of TARDIS.
The first step is to setup up a python environment. :doc:`python_environment`
explains how to do that. Some of this information is also contained in the
:doc:`Installation guide <../installation>`. Once the python environment is
running consult :doc:`git_workflow` to learn about interacting with git and
github for the purpose of developing TARDIS.


General Workflow to add a new feature
Expand All @@ -24,18 +29,18 @@ repository.
In most cases we try to break down big features into small, quantifiable goals
which are then acted upon.

* Document feature to be added in an issue and maybe ask the mailing
list if this feature exists
* Write a test that demonstrates what feature will be added.
* Run the test to verify that it fails in the way you think it should.
* If it fails in an unexpected way, your test may be wrong. This is a
great time to ask the group for guidance
* If it passes, you are done! You just added test coverage to an
already existing feature, and that is great! (unlikely)
* Add the feature (also known as "a simple matter of programming").
* Run the test to verify that it passes.
* Write documentation about your feature.
* close issue/partial PR and add to changelog.


.. include:: release_workflow.inc
* Document feature to be added in an issue and maybe ask the mailing
list if this feature exists
* Write a test that demonstrates what feature will be added.
* Run the test to verify that it fails in the way you think it should.
* If it fails in an unexpected way, your test may be wrong. This is a
great time to ask the group for guidance
* If it passes, you are done! You just added test coverage to an
already existing feature, and that is great! (unlikely)
* Add the feature (also known as "a simple matter of programming").
* Run the test to verify that it passes.
* Write documentation about your feature.
* close issue/partial PR and add to changelog.


.. include:: release_workflow.inc

0 comments on commit ee91db2

Please sign in to comment.