bhklab / handbook

Lab Handbook For BHKLab
https://bhklab.github.io/handbook/dev
1 stars 0 forks source link

docs: Finish tutorial for page review #13

Closed strixy16 closed 1 month ago

strixy16 commented 1 month ago

Steps

jjjermiah commented 1 month ago

from #8 Need to have a process outlined for lab members to follow when adding a page to the handbook.

Things to consider

jjjermiah commented 1 month ago

from #7

Make a tutorial for lab members to use to add pages to the handbook. Can present this at the beginning of any group development session and have it for them to refer back to

Steps could include:

And then a section on how to do code review.

I have a suggestion for this that I discovered in making the tutorial for page making.

If the first step for making a new page is making an issue, it gives you the opportunity to make a branch immediately associated with it. It's on the right side of the page under Development.

Once it's made, it prompts you to checkout the branch locally.

This might simplify how that setup works for newer Git users, as opposed to using git checkout and such. Could be good to provide both alternatives

jjjermiah commented 1 month ago

just consolidating the similar tasks *

jjjermiah commented 1 month ago

closed by #23 and #24