Skip to content
Permalink
Browse files

Merge pull request #222 from madetech/add-contributing-to-the-handboo…

…k-guide

Add "Contributing to the Handbook" page
  • Loading branch information...
zuren committed Apr 1, 2019
2 parents 0a787bd + aeba5b9 commit 48bc54bb87acc28648060fde46e843750f4cba88
Showing with 36 additions and 0 deletions.
  1. +4 −0 README.md
  2. +32 −0 guides/contributing_to_the_handbook.md
@@ -22,6 +22,10 @@ Made Tech's mission is to improve software delivery in every organisation. We bu

We're a company that moves fast, so we're going to need everyone to help us keep this up to date. If you encounter something that you think should be in this Handbook or spot a typo, please feel free to [open a pull request](https://github.com/madetech/handbook/pulls). If you have a question feel free to [open an issue](https://github.com/madetech/handbook/issues). This applies whether you're a Made Tech employee or not :)

### Using the Github user interface

Contributing to the handbook isn't only possible for `git` users, find steps to [create pages through the Github user interface here](guides/contributing_to_the_handbook.md).

## Table of contents

### Introduction to Made Tech
@@ -0,0 +1,32 @@
# 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

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. Get feedback from the wider company and address any feedback. Once you've had your Pull Request approved, you're ready to finalise your change.
2. On the "Conversation" tab of your Pull Request, click "Merge pull request".
3. Your new page will now be visible in the Handbook.

0 comments on commit 48bc54b

Please sign in to comment.
You can’t perform that action at this time.