aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2019-01-23 17:16:49 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2019-01-23 17:21:15 +0000
commit8a0ebd90913231285e443df024b7d2958d0b8bc9 (patch)
tree286345dcd813573eda7a9546c0992f8abeabede6
parent8362ebf4d4efe5452323de31b11384f5b69e8fbf (diff)
New note to checklist for including pipeline-origin in new clone
I needed to take these steps in a few occasions on a project I am building over this pipeline. This will commonly happen when a team starts using this pipeline, so it was added to make things easier.
-rw-r--r--.file-metadatabin4430 -> 4430 bytes
-rw-r--r--README-hacking.md16
2 files changed, 16 insertions, 0 deletions
diff --git a/.file-metadata b/.file-metadata
index 2ef6a26..c6aa9d2 100644
--- a/.file-metadata
+++ b/.file-metadata
Binary files differ
diff --git a/README-hacking.md b/README-hacking.md
index 7fb42a2..5fd74b6 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -687,6 +687,22 @@ advanced in later stages of your work.
$ git merge pipeline # Import all the work into master.
```
+ - **Adding this project to a fork of your pipeline**: As you and your
+ colleagues continue your project in this pipeline, it will be
+ necessary to have separate forks/clones of it. But when you clone your
+ own project on a different system, or a colleague clones it to
+ collaborate with you, the clone won't have the `pipeline-origin`
+ remote that you started the project with. As shown in the previous
+ point, you need this remote to be able to pull recent updates from
+ this pipeline. The steps below, will setup the `pipeline-origin`
+ remote, and a `pipeline` branch to track it, on the new clone.
+
+ ```shell
+ $ git remote add pipeline-origin https://gitlab.com/makhlaghi/reproducible-paper.git
+ $ git fetch pipeline-origin
+ $ git checkout --track pipeline-origin/pipeline
+ ```
+
- **Pre-publication: add notice on reproducibility**: Add a notice
somewhere prominent in the first page within your paper, informing the
reader that your research is fully reproducible. For example in the