jperkel / mymanuscript Goto Github PK

Here's some feedback on the methods section describing how "to contribute to this document" (the link to that section is versioned so will not update when the manuscript changes).

Currently, 8 steps are described for how to contribute. They look good to me.

It's possible to skip step 2 to "‘Fork’ a copy of the repository to your own GitHub account by clicking the Fork icon at the top of the page."

Instead if you click the pencil icon on a content file, you'll get a web editor with the following note:

You’re editing a file in a project you don’t have write access to. We’ve created a fork of this project for you to commit your proposed changes to. Submitting a change to this file will write it to a new branch in your fork, so you can send a pull request.

Users who do this won't be able to change the branch name as described in:

The software will suggest a new name for this branch, like jperkel-patch-1; you can change that if you’d like.

So overall I think your instructions are great. I'm not sure whether it's best to explicitly instruct users to create a fork first or to rely on GitHub's auto-forks. I think how you have it now is fine.

But just wanted to make you aware of this intricacy!