You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: WORKFLOW.md
+39
Original file line number
Diff line number
Diff line change
@@ -109,3 +109,42 @@ The project is usable as CMake subproject. Explicit references to
109
109
break subproject builds.
110
110
An example project is available [here](https://github.com/fortran-lang/stdlib-cmake-example)
111
111
to test the CMake subproject integration.
112
+
113
+
## GitHub collaboration
114
+
115
+
Contributing can be daunting, we know! Even more for a big project with many contributors, and if you are not expert on the whole github workflow then even more, we have been there at some point.
116
+
117
+
In order to help lowering the barrier for collaborating on ongoing efforts (e.g. an open PR), we have crafted a simple script that might come in handy. To explain the process we'll use Alice (the person you want to help) and Bob (you):
118
+
119
+
┌────────────────────────────┐
120
+
│ fortran-lang/stdlib │
121
+
└────────────▲───────────────┘
122
+
│
123
+
│ [Pull Request]
124
+
│
125
+
┌───────┴────────┐
126
+
│ alice/stdlib │ ←─────┐
127
+
└──────▲─────────┘ │
128
+
│ │
129
+
[PR Branch] ←───┘ ┌──────┴──────┐
130
+
feature-branch │ bob/stdlib │
131
+
(hosted here) │ (fork) │
132
+
└─────────────┘
133
+
▲
134
+
│
135
+
[Push access to Alice's repo]
136
+
137
+
After having forked from `fortran-lang/stdlib` and cloned your `stdlib` fork on your local machine; on an unix compatible terminal with access to the `git` CLI, being at the root folder:
138
+
```sh
139
+
./.github/collab.sh
140
+
```
141
+
You will be asked to enter the username and branch of the other person:
142
+
```bash
143
+
Enter the GitHub username of the fork owner (e.g., alice): alice
144
+
Enter the PR branch name (e.g., feature-branch): feature-branch
145
+
```
146
+
This will fetch Alice's repository and switch your view to Alice's feature-branch. Now you can review, build, run, play around, propose your nice improvements.
147
+
148
+
Once you finish helping out, you can always `git checkout <your_own_branch>` and/or delet Alice's branch from your local view `git branch -d feature-branch`.
0 commit comments