search

IUPAC / WFChemCookbook

The IUPAC WorldFAIR Cookbook for FAIR chemical data
https://iupac.github.io/WFChemCookbook
Creative Commons Attribution 4.0 International
14 stars 4 forks source link

Addition of worked example of GitHub #23

Open nk1g09 opened 10 months ago

nk1g09 commented 10 months ago

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.

nk1g09 commented 9 months ago

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.

stuchalk commented 7 months ago

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...

stuchalk commented 4 months ago

@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 ...