ejh243 / BrainFANS

Complex Disease Epigenomics Group's quality control and analysis pipelines for DNA methylation arrays, SNP arrays, BS-Seq, ATAC-Seq and ChIP-Seq
Other
10 stars 4 forks source link

[Documentation Fault]: encourage use of `git pull --rebase` #136

Closed sof202 closed 4 months ago

sof202 commented 6 months ago

Contact Details

No response

Fault type

Incorrect/outdated information given

Please describe the fault in detail

If multiple people are working on the same branch, the current guidance is to have users use git pull before pushing their commits (as otherwise their push will be rejected). However, this results in git calling git merge, which will result in unhelpful merge commits cropping up in a pull request. This has already happened multiple times with pull request #116.

A slightly better approach would be to rebase when using git pull (git pull --rebase). This way the git commit history is a little more clear as you can see the progression of the feature branch better.

This will of course not work if there is a merge conflict. In which case a regular git pull is required.