Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Contributing to the Handbook" page #222

Merged
merged 3 commits into from Apr 1, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -0,0 +1,30 @@
# Contributing to the Handbook

This guide aims to make it easier to submit changes to the Handbook without using `git` or a text editor.

## Adding new pages in Github

### Creating the page

This comment has been minimized.

Copy link
@ccp92

ccp92 Mar 8, 2019

Contributor

Maybe could do with something around editing an existing file as well?

This comment has been minimized.

Copy link
@zuren

zuren Mar 29, 2019

Author Member

Out of scope! Good point though.


1. [Go to the handbook.](https://github.com/madetech/handbook)
2. Click through to the folder you want.
3. Click "Create new file"
4. Type out your contents under "Edit new file" using [Markdown](https://guides.github.com/features/mastering-markdown/).
5. Preview your changes at any time by clicking "Preview".
6. When you're happy with your page, write a short description under "Commit new file". For example, "Add Flexible Holiday Page".
7. Select "Create a new branch for this commit" and give it a name relevant to your change. For example, "add-flexible-holiday-page".
8. Submit the change by clicking "Propose new file".
9. You will be then be able to create a Pull Request to get review of your new page. Click "Create pull request", then share the link with people!

### Addressing review

1. Click on the "Files changed" tab on your Pull Request.
2. Click on the pencil icon in the toolbar above the file content.
3. Make your changes as before, previewing until you're happy with them.
4. Under "Commit Changes" describe what this change does. For example, "Fix typo" or "Extend section on getting a company credit card".
5. Keep the selected option as "Commit directly". You don't need to create a new branch for every change.
6. Press "Commit changes".

### Finalising the change

1. On the "Conversation" tab of your Pull Request, click "Merge pull request".

This comment has been minimized.

Copy link
@StevenLeighton21

StevenLeighton21 Mar 8, 2019

Suggest a note on PR etiquette? As simple as When your proposal has approval, click....

This comment has been minimized.

Copy link
@zuren

zuren Mar 8, 2019

Author Member

Nice idea.

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.