Skip to content

Commit

Permalink
docs: short git intro
Browse files Browse the repository at this point in the history
  • Loading branch information
marrip committed Feb 27, 2024
1 parent efe82f6 commit 764e39a
Showing 1 changed file with 73 additions and 3 deletions.
76 changes: 73 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,86 @@ A two-day workshop for bioinformaticians and molecular biologists with focus on

## 2. Development & Collaboration

- short git introduction (basic git commands, optional)
- branching system (gitflow workflow)
### Short `git` introduction

- distributed version control system
- tracks history of changes commited by different contributors
- every developer has full copy of project and its history

---

### Short `git` introduction

#### Basic `git` commands

`git init`: initialises new git repository

`git clone <repository url>`: creates local copy of remote repository

`git add <file/s>`: stage new or changed files (anything that should be committed to the repository)

`git commit -m "feat: my new feature"`: commit changes to the repository

---

#### Basic `git` commands

##### commit message conventions

`<type>[optional scope]: <description>`

- `feat`: new feature
- `fix`: patching bug
- `refactor`: code change that neither is neither feat nor fix
- `build`: build system related changes
- `perf`: improving performance

---

##### commit message conventions

`<type>[optional scope]: <description>`

- `chore`: code unrelated changes, e.g. dependencies
- `style`: code change that does not change meaning
- `test`: changes to tests
- `docs`: adding/updating documentation
- `ci`: continuous integration, e.g. github actions

---

#### Basic `git` commands

`git status`: overview over untracked, modified and staged changes

`git branch`: show local branches

`git merge`: merge branches

`git pull`: load changes from remote counterpart

`git push`: upload changes to remote counterpart

---

### Branching strategy - Gitflow

---

- github actions (linting, testing, building)
- pull requests (best practice)
- release and semantic versioning
- licensing

---

## 2. Resources

- [About Git](https://docs.github.com/en/get-started/using-git/about-git)
- [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)

---

## 3. Nextflow

- general (install, best practice)
Expand All @@ -152,7 +223,6 @@ A two-day workshop for bioinformaticians and molecular biologists with focus on

### Resources

- [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
- [github actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions)
- [nf-core](https://nf-co.re/)
- [pytest unittesting](https://www.datacamp.com/tutorial/pytest-tutorial-a-hands-on-guide-to-unit-testing)
Expand Down

0 comments on commit 764e39a

Please sign in to comment.