Skip to content

Commit

Permalink
add figure of git flow
Browse files Browse the repository at this point in the history
  • Loading branch information
venpopov committed Feb 13, 2024
1 parent 56f4474 commit 80a36cb
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 2 deletions.
Binary file added _book/images/clipboard-674159866.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion _book/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,13 @@ <h1 class="title">BMM Developer Notes</h1>
<section id="overview" class="level1 unnumbered">
<h1 class="unnumbered">Overview</h1>
<p>This article aims to help developers contribute new models to bmm. It is a work in progress and will be updated as the package evolves. It explains how to set-up your system for package development, the structure of the package, and the workflow for contributing new models to the package.</p>
<p>We follow a github flow workflow. The repository contains two main branches:</p>
<p>We follow a <a href="https://jeffkreeftmeijer.com/git-flow/">github flow workflow</a>. The repository contains two main branches:</p>
<ul>
<li><p>Master (contains the latest released stable version of the <code>bmm</code> package</p></li>
<li><p>Develop (contains the latest stable development branch</p></li>
</ul>
<p>All new feature development should occur on an independent branch from Develop. If you want to contribute a new model to the <code>bmm</code> package, you need to fork the repository, create a new branch for your model, extensively test the model, and eventually submit a pull request for your changes to be merged into the Develop branch of the main repository. Your changes will be reviewed by someone from the core team. Once your changes are merged into the Develop branch, they will be included in the next release of the package.</p>
<p><img src="images/clipboard-674159866.png" class="img-fluid"></p>


</section>
Expand Down
Binary file added images/clipboard-674159866.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

This article aims to help developers contribute new models to bmm. It is a work in progress and will be updated as the package evolves. It explains how to set-up your system for package development, the structure of the package, and the workflow for contributing new models to the package.

We follow a github flow workflow. The repository contains two main branches:
We follow a [github flow workflow](https://jeffkreeftmeijer.com/git-flow/). The repository contains two main branches:

- Master (contains the latest released stable version of the `bmm` package

- Develop (contains the latest stable development branch

All new feature development should occur on an independent branch from Develop. If you want to contribute a new model to the `bmm` package, you need to fork the repository, create a new branch for your model, extensively test the model, and eventually submit a pull request for your changes to be merged into the Develop branch of the main repository. Your changes will be reviewed by someone from the core team. Once your changes are merged into the Develop branch, they will be included in the next release of the package.

![](images/clipboard-674159866.png)

0 comments on commit 80a36cb

Please sign in to comment.