Skip to content

Commit

Permalink
Specify "workflow for pull requests"
Browse files Browse the repository at this point in the history
also add some additional info
  • Loading branch information
mptrsen authored Nov 17, 2023
1 parent 621e14d commit f9b7fe5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ all tailored for HPC systems.

If you want to participate in the development: Just notify us (issue) and we will add your github account. Alternatively, you may fork the repo and create PRs from there.

Workflow:
Workflow for pull requests:

- create or take an issue to work on (you may assign others or no one). Issues ought to be as specific as possible. We may break "big issues" into smaller ones
- create a branch `"<shortname>_<issue_number>"`. Only in rare case (closely related issues) bundle the work on issues into one branch. The parent branch should always be "main"
- commit your work to branch
- push to origin
- push to origin (your own fork of the snakemake-hpc-teaching-material repository)
- create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
- assign arbitrary reviewer (or wait until someone takes on this pull reqeust)
- (s.o. else) perform review (switch to branch and try; check the quality)
Expand Down

0 comments on commit f9b7fe5

Please sign in to comment.