-
Notifications
You must be signed in to change notification settings - Fork 3
Add guide for creating new prototypes (using the GitHub template) #391
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
base: main
Are you sure you want to change the base?
Changes from all commits
fbe75f3
d65b8b1
0c049ad
fd3da3f
d31ea82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| eleventyNavigation: | ||
| key: Creating a new prototype | ||
| title: Creating a new prototype | ||
| description: Use the template on the GitHub website. | ||
|
|
||
| order: 1 | ||
| tags: | ||
| - setup | ||
| --- | ||
|
|
||
| You will first need to create a free GitHub account if you do not already one, and sign in. | ||
|
|
||
| Then visit the [NHS prototype kit on GitHub](https://github.com/nhsuk/nhsuk-prototype-kit), click the ‘Use this template’ button and select ‘Create a new repository’: | ||
|
|
||
|  | ||
|
|
||
| You'll then be taken to a screen where you can enter some details about your project: | ||
|
|
||
|  | ||
|
|
||
| Here’s how to complete the fields: | ||
|
|
||
| * **Include all branches**: leave this in the ‘off’ setting | ||
| * **Owner**: this should be the name of the organisation you are working for. If you have not yet been added to your organisation on GitHub you should ask to be added. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe mention that if you're just trying it out, you can make it personal? Or maybe that's obvious?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point! Could also say that you can change the owner later if needed. |
||
| * **Repository name**: this should be the name of the service you are prototyping. You can change this later if you are not yet sure of the name. By convention it is lowercase and uses hyphens instead of spaces. Add the suffix `-prototype` to make it clear to others in your organisation that it is a prototype. | ||
| * **Description**: this is optional and you can leave it blank for now, or enter a short description of what the service you are prototyping will do. | ||
| * **Choose visibility**: You can choose to make your prototype code public or private. This can be changed later. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could say: by default public sector work should be open source, so make it public unless you expect to have sensitive information in it. For example, it's related to an unannounced policy. |
||
|
|
||
| Click the ‘Create repository’ button when you are ready. This will create a copy of the NHS prototype kit for your new prototype. | ||
|
|
||
| You can then run and edit the prototype either on your computer or in the cloud. See [Get started](/install) for guides to both options. | ||
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.
Is this true or is it more accurate to say:
Maybe gives enough detail for someone to be able to Google how to do this?
Maybe not important?