Addition of worked example of GitHub #23
Conversation
There was a problem hiding this comment.
@nk1g09 Great work! Really well written, nice screen shots.
We haven't properly documented the scope of the Cookbook (and our CONTRIBUTING documentation is pretty anemic). Had we done so, I'd say this piece is out of scope for our samples section, but it would be fantastic for augmenting our How To Contribute section. Do you have an opinion on any of the following?
- Once I get a PR together baking out contributing, you could migrate this work into that piece of work
- I could just directly include this work in my generated PR. I'd start from this branch, so you'd still get credit & blame.
- We could try to identify a practical chemical information application of this example, and migrate to that. The explanations of Version Control etc. would be valuable as primary educational tools.
If this is going to be in the samples section, it'll need to conform to some templates that @stuchalk is putting together. Again, I apologize for pointing at a moving target on that.
|
Hi Ken, Apologies I didn't see this earlier (my github notfications clearly don't come through as expected). I'm happy for this to be changed as necessary, it probably is in the wrong section as it didn't really seem to fit with any of the existing items. Happy for you to adapt this for the contributing guide. This was angled as an introduction to Github, and the contribution use case was identified as a good one as we didn't have an obvious chemistry angle. But we could definitely split it out if we have a different exemplar that I could redo the screenshots for. |
|
NIki, I have just added documentation about contributing to the Cookbook on the repository's Wiki. If you have time would appreciate a quick read and feedback... If possible would be good to touch base on getting your contribution finished before the holidays... |
|
@nk1g09 Please go ahead and modify you recipe to support the PR via a fork workflow. I will get it in the Cookbook as soon as I can ... |
Now located in contributions folder.
Updated numbering, image links and minor typos
Adding an introductory guide to GitHub with a worked example showing contributing to the WFChemCookBook.
Please amend the location / contents as necessary, or let me know of any changes that need to be made.
Currently this guide is through the GUI on windows, but could be extended in future to include command line prompts, differences for Mac.
It also does not cover some more complex elements such as conflict resolution.