Skip to content

Commit c5caca6

Browse files
author
Melody Kramer
committed
Merge pull request 18F#11 from krues8dr/18f-pages
Adding suggestions to naming conventions.
2 parents a44339f + a452d90 commit c5caca6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pages/naming-your-project.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ title: Naming your project
66

77
### Before naming a project, think ‘Is this easy to understand?’
88

9-
We recommend using descriptive names and avoid acronyms. It’s also important to check with your communications team before naming a project so that it can be cleared, if need be.
9+
To help users find and recognize your project, we recommend using descriptive names that describe what your project does. You should avoid acronyms and clever names/puns as those can make it hard to search for projects.
1010

11-
For example, if you were creating a template your coworkers could use to create guides, a good name for the repo might be *guides-template*. A bad name might be *the-unnamed-project-that-makes-it-easy-to-build-stuff*.
11+
You should also do a quick search on the web for your project's name to make sure that name isn't already being used by other software or services, even if it's used in a different space, as it can be confusing for new users. It’s also important to check with your communications team before naming a project so that it can be cleared, if need be.
12+
13+
For example, if you were creating a template your coworkers could use to create guides, a good name for the repo might be *guides-template*. Bad names might include *the-unnamed-project-that-makes-it-easy-to-build-stuff*, *temp-latte*, or *guidestar*.

0 commit comments

Comments
 (0)