Skip to content

Commit

Permalink
context of guide
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardchalstrey1 committed Jul 15, 2024
1 parent 7d84165 commit 2e1a2f7
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/contribute/developers-guide.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Developer's Guide
=================

The Seshat project is open source and welcomes contributions from developers. This guide is written for the core project maintainers working at the Complexity Science Hub in Vienna and The Alan Turing Institute in London.

Getting started
---------------

Expand Down Expand Up @@ -69,6 +71,13 @@ Development workflow
- **TODO:** *add link to unwritten production deployment guide*
- Ensure any new migrations added in the pull request are applied to the database. **TODO:** *add link to another page with Django notes*


GitHub workflow visualised
---------------------------

As described above, development on Seshat follows a basic GitHub workflow. The diagram below illustrates the steps involved in the process, from selecting an issue to merging a pull request. Note that the master branch is called `dev` in the Seshat repository. Feature branches should be named appropriately based on the issue they are addressing.


.. image:: ../img/basic_github_workflow.webp
:alt: Seshat development workflow

Expand Down

0 comments on commit 2e1a2f7

Please sign in to comment.