Skip to content

Instructions unclear

I got a little lost in this one. The instructions made it fairly clear how to make a branch, and submit a merge request, but it was much less clear what steps the reader was supposed to take to follow along and do this as an exercise.

For instance, the readme describes the code requirements first, then it talks about raising an issue and creating a branch. So I got the strong impression that I was supposed to write the function first and commit those changes to master, then, raise an issue, and then write more code for the branch. But if I've already written the function correctly the first time, what issue can I raise, and what do I do in the branch?

I think it would be easier to follow if it starts with an explanation of 'forking', and a clear instruction to create a new repository (with steps). Then describe branching, and tell the user to create a new branch, THEN describe the requirements properly, and finally talk about merging.