Skip to content

Commit fa1e2cc

Browse files
authored
fix TOC links and improve format
1 parent 0da4361 commit fa1e2cc

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ or _data management conventions_.
1010
<!-- toc -->
1111

1212
* [GitHub](#github)
13-
+ [Repository Names](#repository-names
14-
- [Use all lowercase letters.](#use-all-lowercase-letters-1)
15-
- [Use hyphenated spaces.](#use-hyphenated-spaces-1)
13+
+ [Repository Names](#repository-names)
14+
- [Use all lowercase letters.](#use-all-lowercase-letters)
15+
- [Use hyphenated spaces.](#use-hyphenated-spaces)
1616
- [Use versionless phrases.](#use-versionless-phrases)
1717
+ [Branch Names](#branch-names)
1818

@@ -21,28 +21,34 @@ or _data management conventions_.
2121

2222
## GitHub
2323

24-
### Repository Names - first word
24+
### Repository Names
2525

2626
A lab's GitHub organization hosts many repositories that we use to collaborate. Each
27-
repository name should represent the most general possible topic description for that
28-
project. All repositories **must** start with one of the following terms:
27+
repository name should represent the most general possible description for that
28+
project. A few examples of repository names in our lab:
2929

30-
task: refers to javascript/matlab/python tasks.
31-
analysis: all sorts of analysis and data processing.
32-
model: a computetional model.
33-
download: a script for data download.
34-
class: code and data associated with classes that were taken by the lab.
35-
tools: general tools associated with the lab.
30+
- [`task-ethics-amplification-jonas`](https://github.com/GoldenbergLab/task-ethics-amplification-jonas)
31+
- [`download-loneliness-twitter-api`](https://github.com/GoldenbergLab/download-loneliness-twitter-api)
3632

37-
### Repository Names - last word
33+
**First & Last Word**
3834

39-
The last word in the reporsitory names shoudl **always** include the name of the person who created the repo.
35+
In the Goldenberg Lab, all repositories **must start with** one of the following terms:
4036

37+
- `task`: refers to JavaScript/MATLAB/Python tasks
38+
- `analysis`: all sorts of analysis and data processing
39+
- `model`: a computational model
40+
- `download`: scripts for downloading data
41+
- `class`: code and data associated with classes that were taken by the lab
42+
- `tools`: general tools associated with the lab
4143

42-
### Repository Names - rest of text
44+
And, they **should end with** the name of the person who created the repo.
4345

44-
The test of text should include information that would help an outside observer identify the specific meaning of the repo.
45-
In addition, please follow these guidelines:
46+
_Note: There are a few exceptions to the rule, i.e., `twitter-survey-` prefixed projects or organizational health repos like `.github`). Please check with Amit to determine if your project might be such an exception._
47+
48+
**Body**
49+
50+
The rest of the repo's name should include information that would help an outside observer identify the project content of the repo.
51+
Please follow these guidelines:
4652

4753
#### Use all lowercase letters.
4854

0 commit comments

Comments
 (0)