Skip to content

Commit

Permalink
Fix formatting for RFC 63
Browse files Browse the repository at this point in the history
  • Loading branch information
timblair committed May 17, 2017
1 parent 0c96d5e commit f19a250
Showing 1 changed file with 22 additions and 16 deletions.
38 changes: 22 additions & 16 deletions rfc-063-naming-new-apps-gems-on-gov-uk.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
## Problem

Apps and gems on GOV.UK have history followed different naming schemes. Recently we've established a pattern we're quite happy with, but we've never written that down.
Apps and gems on GOV.UK have history followed different naming schemes.
Recently we've established a pattern we're quite happy with, but we've never
written that down.

This RFC is an attempt to write down the current conventions.

## Naming applications

Firstly, the [service manual has good guidance on naming things](https://www.gov.uk/service-manual/design/naming-your-service).
Firstly, the [service manual has good guidance on naming
things](https://www.gov.uk/service-manual/design/naming-your-service).

The most important rules:

- The name should be self-descriptive. No branding or puns (like Rummager, Needotron and Maslow) 
- Use  **dashes**  for the URL and GitHub repo
- The name should be self-descriptive. No branding or puns (like Rummager,
Needotron and Maslow)
- Use **dashes** for the URL and GitHub repo
- The name of the app should be the same on GitHub, Puppet and hostname

**Publishing applications**
### Publishing applications

Applications that publish things are named **x-publisher**. 
Applications that publish things are named **x-publisher**.

Good:

Expand All @@ -28,9 +32,10 @@ Not so good:
- publisher (too generic)
- contacts-admin (could be contacts-publisher)

**Frontend applications**
### Frontend applications

Applications that render content to end users on GOV.UK are named **x-frontend**
Applications that render content to end users on GOV.UK are named
**x-frontend**

Good:

Expand All @@ -42,9 +47,9 @@ Not so good:
- collections (could be collections-frontend)
- frontend (too generic)

**APIs**
### APIs

. 
Applications that just expose an API are named **x-api**.

Good:

Expand All @@ -56,9 +61,10 @@ Not so good:

- rummager (should be search-api)

**Admin applications**
### Admin applications

Applications that "manage" things can be called **x-manager ** or **x-admin** or **thing-doer.**
Applications that "manage" things can be called **x-manager** or **x-admin** or
**thing-doer**.

Good:

Expand All @@ -73,20 +79,20 @@ No so good:

## Naming gems

- Use the official [Rubygems naming convention](http://guides.rubygems.org/name-your-gem/) - use underscores for multiple words.
- Use the official [Rubygems naming
convention](http://guides.rubygems.org/name-your-gem/)
- Use underscores for multiple words
- Use `govuk_` prefix if the gem is only interesting to projects within GOV.UK

Good:

- govuk\_sidekiq
- govuk\_content\_models
- govuk\_admin\_template
- vcloud-edge\_gateway

- vcloud-edge\_gateway

Not so good:

- slimmer
- plek
- gds-sso (should be gds\_sso, or govuk\_sso)

0 comments on commit f19a250

Please sign in to comment.