Skip to content

Commit

Permalink
chore: branch image and main
Browse files Browse the repository at this point in the history
  • Loading branch information
bms63 committed Nov 16, 2023
1 parent 75872a4 commit 6c3b927
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions vignettes/git_usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,12 @@ This article will give you an overview of how the `{admiral}` project is utilizi

# Branches

- The `main` branch contains the latest **released** version and should not be used for development. You can find the released versions [here](https://GitHub.com/pharmaverse/admiral/releases)
- The `devel` branch contains the latest development version of the package. You will always be branching off and pulling into the `devel` branch. This is set as the default branch on GitHub.
- The `gh-pages` branches contains the code used to render this website you are looking at right now!
- The `main` branch contains the latest development version of the package. You can find the released versions [here](https://GitHub.com/pharmaverse/admiral/releases)
- The `gh-pages` branches contains the code used to render R package websites - you are looking at right now!
- The `patch` branch is reserved for special hot fixes to address bugs and should rarely be used. More info in [Hot Fix Release](release_strategy.html#hot-fix-release)
- The `main`, `gh-pages`, `patch` branches are under protection. If you try and push changes to these branches you will get an error unless you are an administrator.

- **Feature** branches are where actual development related to a specific issue happens. Feature branches are merged into `devel` once a pull request is merged. Check out the [Pull Request Review Guidance](pr_review_guidance.html) for more guidance on merging into `devel`.
- **Feature** branches are where actual development related to a specific issue happens. Feature branches are merged into `main` once a pull request is merged. Check out the [Pull Request Review Guidance](pr_review_guidance.html) for more guidance on merging into `main`.

# Working with Feature Branches

Expand Down
Binary file modified vignettes/github_feature_branch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6c3b927

Please sign in to comment.