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
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe could do with something around editing an existing file as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Out of scope! Good point though.