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
- Go to the handbook.
- Click through to the folder you want.
- Click "Create new file"
- Type out your contents under "Edit new file" using Markdown.
- Preview your changes at any time by clicking "Preview".
- When you're happy with your page, write a short description under "Commit new file". For example, "Add Flexible Holiday Page".
- Select "Create a new branch for this commit" and give it a name relevant to your change. For example, "add-flexible-holiday-page".
- Submit the change by clicking "Propose new file".
- 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!
- Click on the "Files changed" tab on your Pull Request.
- Click on the pencil icon in the toolbar above the file content.
- Make your changes as before, previewing until you're happy with them.
- Under "Commit Changes" describe what this change does. For example, "Fix typo" or "Extend section on getting a company credit card".
- Keep the selected option as "Commit directly". You don't need to create a new branch for every change.
- Press "Commit changes".
Finalising the change
- 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.
- On the "Conversation" tab of your Pull Request, click "Merge pull request".
- Your new page will now be visible in the Handbook.