Skip to content

Commit

Permalink
Add git workflow and glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
JarnoRFB committed Apr 13, 2018
1 parent b5716e7 commit 5ca63cf
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/git_workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Git workflow
============

This workflow describes the process of adding code to the repository.

#. Describe what you want to achieve in an issue.
#. Pull the master to get up to date.

#. ``git checkout master``
#. ``git pull``

#. Create a new local branch with ``git checkout -b <name-for-your-branch>``.
It can make sense to prefix your branch with a description like ``feature`` or ``fix``.
#. Solve the issue, most probably in several commits.
#. Push your branch to github with ``git push origin <name-for-your-branch>``.
#. Go to github and switch to your branch.
#. Send a pull request from the web UI on github.
#. After you received comments on your code, you can simply update your
pull request by pushing to the same branch again.
#. Once your changes are accepted, merge your branch into master. This can
also be done by the last reviewer that accepts the pull request.
12 changes: 12 additions & 0 deletions docs/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

Glossary
========

Glossary for mathematical terms
-------------------------------

Spherical Harmonic power spectrum [Tishby (2017) 3.1 Experimental setup]
???

O(3) rotations of the sphere [Tishby (2017) 3.1 Experimental setup]
???
16 changes: 15 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,23 @@
Welcome to Deep Bottleneck's documentation!
===========================================

A short restructeredText `reference <https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst>`_.
There is also a longer `video tutorial <https://www.youtube.com/watch?v=hM4I58TA72g>`_

This is just to demonstrate latex.

.. math::
(a + b)^2 = a^2 + 2ab + b^2
(a - b)^2 = a^2 - 2ab + b^2
.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Contents

glossary
git_workflow



Expand Down

0 comments on commit 5ca63cf

Please sign in to comment.