Buck9195/Gladstone-Bioinformatics-Workshop
1
0
Fork 0
mirror of https://github.com/gladstone-institutes/Bioinformatics-Workshops.git synced 2025-11-30 09:45:43 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update workflows.md

Browse source
This commit is contained in:
Alexander Pico 2022-05-27 12:59:51 -07:00 • committed by GitHub
parent 5787ef2e1b
commit d293f76380
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Using-git-and-github/workflows.md
View file

@ -6,8 +6,8 @@ The appropriate workflow model depends on the size of your team and the type of
`tldr`
* Use feature branches, e.g., `add-cleaning-step` for changes
* When code in feature branch is solid, merge it into `master` branch
* Always keep your `master` branch in "last known good" state (working, production-ready, deployable)
* When code in feature branch is solid, merge it into `main` branch
* Always keep your `main` branch in "last known good" state (working, production-ready, deployable)
## What to Commit
Don't commit everything: be deliberate. Never commit files with passwords or API keys. Avoid committing build artifacts, temporary and meta files like `*.swp`, `*.DS_Store`, `*.jar` and `*.pyc` files. Be judicious when deciding whether to commit source data. If you can reference the source and have your scripts download the data if it's not already present, you can reduce the size of your git repo.
@ -15,18 +15,18 @@ Don't commit everything: be deliberate. Never commit files with passwords or API
To tell git to ignore certain types of files, you can add a `.gitignore_global` file to your home directory and a `.gitignore` file to your project directory. Reference [these templates](https://github.com/github/gitignore) for examples.
`tldr`
Be sure your home directory has a `.gitignore_global` file like one of these: [Linux](https://github.com/github/gitignore/blob/master/Global/Linux.gitignore), [macOS](https://github.com/github/gitignore/blob/master/Global/macOS.gitignore) or [Windows](https://github.com/github/gitignore/blob/master/Global/Windows.gitignore)
Be sure your home directory has a `.gitignore_global` file like one of these: [Linux](https://github.com/github/gitignore/blob/main/Global/Linux.gitignore), [macOS](https://github.com/github/gitignore/blob/main/Global/macOS.gitignore) or [Windows](https://github.com/github/gitignore/blob/main/Global/Windows.gitignore)
## [Tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging)
Whenever you deploy code or run a publishable job, tag your code using [semantic versioning](http://semver.org/).
## [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
To update a feature branch so the changes it contains are applied on top of the latest from `origin/master`:
To update a feature branch so the changes it contains are applied on top of the latest from `origin/main`:
```
git fetch
git checkout my-new-feat
git rebase origin/master
git rebase origin/main
```
See [this post](https://blog.algolia.com/master-git-rebase/).
See [this post](https://blog.algolia.com/main-git-rebase/).