Documentation

[tom-h]

I'm going to put documentation, including generic "how to edit a thing" guides, and the style guide, up in the wiki

So this issue is for the meta-discussion: what should be in documentation, what is good, bad, ugly, etc.

[tom-h]

Now that we have the files imported, most simply edits will be of a single file. For that, I have added a preliminary guide to submitting pull requests.

[tom-h]

There is now a basic style guide that also explains how the front matter works.

[klevetate]

Nice, thanks @tom-h

[klevetate]

Question @tom-h - when I have made changes to a Thing and created a pull request, and then want to work on a new Thing, do I have to fork the main repo again, then branch? Or can I go from my existing fork and create a new branch (assuming no one has made changes to the new Thing in the main repo)?

[tom-h]

not quite, but close. step 1 fork once and once only step 2 (if necessary, refresh the gh-pages branch in your fork, so it's the same as upstream) step 3 branch from gh-pages in your fork step 4 commit changes to that branch step 5 make a PR to merge your branch in your fork to the upstream repo Every time you want to do a new separate task, even if you're not ready to do a PR, then start from step 2. Never commit anything to the gh-pages branch in your fork. It should only ever be updated by pulling and merging the upstream gh-pages branch into your fork's gh-pages branch. Think of it as your copy of the main repo, and that every branch that you create in your fork is where you do your bits of work. I think I still need to add step two to the documentation actually.

…

On Thu, Feb 13, 2020 at 3:10 PM Kerry Levett ***@***.***> wrote: Question @tom-h <https://github.com/tom-h> - when I have made changes to a Thing and created a pull request, and then want to work on a new Thing, do I have to fork the main repo again, then branch? Or can I go from my existing fork and create a new branch (assuming no one has made changes to the new Thing in the main repo)? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#56?email_source=notifications&email_token=AAFLVSHANT6LB2EOEUF5UATRCTB5BA5CNFSM4KKQWA6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOELTKLDI#issuecomment-585541005>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFLVSAPL5OE7TPSJYUC2NDRCTB5BANCNFSM4KKQWA6A> .

[tom-h]

@klevetate I updated the documentation to include more detail on syncing your fork. Please have a look when you get a chance.

[klevetate]

Hey @tom-h I forgot to say, I really like the documentation - style guide and instructions for editing are super helpful. Thanks!

[tom-h]

No worries :-)