You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-29Lines changed: 31 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,26 @@
2
2
3
3
This repository defines the organizational structure, team membership, and project ownership for ScottyLabs' Tech Committee. It serves as the source of truth for our GitHub organization's governance model.
4
4
5
-
In this document, 'ScottyLabs' will refer to the GitHub organization at https://github.com/ScottyLabs, and not the club itself.
5
+
In this document, 'ScottyLabs' will refer to the GitHub organization at <https://github.com/ScottyLabs>, and not the club itself.
├── docs # Specific instructions for all three file types
18
18
├── repos # Team definitions with members and repos
19
19
└── teams # Repository definitions with metadata
20
20
```
21
21
22
-
-**Contributors** - Individuals who participate in ScottyLabs projects
23
-
-**Teams** - Groups of contributors working on specific projects
24
-
-**Repositories** - Code repositories owned by teams
22
+
-**Contributors** - Individuals who participate in ScottyLabs projects
23
+
-**Teams** - Groups of contributors working on specific projects
24
+
-**Repositories** - Code repositories owned by teams
25
25
26
26
Depending on what you are trying to register, follow the respective guide under `docs/`.
27
27
@@ -31,45 +31,47 @@ We enforce [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/
31
31
32
32
This repository also includes several other checks to ensure integrity:
33
33
34
-
- File names must match the content (the `name` field for repos and teams, the `github-username` field for contributors)
35
-
- Cross-references must be valid (team members must exist as contributors, team repos must exist as repos)
36
-
- GitHub users must exist
37
-
- Slack member IDs and channel IDs must be valid
34
+
- File names must match the content (the `name` field for repos and teams, the `github-username` field for contributors)
35
+
- Cross-references must be valid (team members must exist as contributors, team repos must exist as repos)
36
+
- GitHub users must exist
37
+
- Slack member IDs and channel IDs must be valid
38
+
39
+
## Development
38
40
39
-
Validation runs automatically through GitHub Actions on PRs and pushes to main. However, you can also test validators locally:
41
+
Validation runs automatically through GitHub Actions on PRs and pushes to main, so the following instructions will not be relevant to most people. If you are interested, you can also test validators locally:
40
42
41
43
1. Make sure you are in the root of the repository.
42
44
43
45
2. Install Rust with `rustup`, if you do not already have it installed:
44
46
45
-
```sh
46
-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
47
-
```
47
+
```sh
48
+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
49
+
```
48
50
49
51
3. Install `cargo-binstall` (enables use of `cargo binstall`):
50
52
51
-
```sh
52
-
cargo install cargo-binstall
53
-
```
53
+
```sh
54
+
cargo install cargo-binstall
55
+
```
54
56
55
57
4. Install Taplo:
56
58
57
-
```sh
58
-
cargo binstall taplo-cli
59
-
```
59
+
```sh
60
+
cargo binstall taplo-cli
61
+
```
60
62
61
63
5. Check TOML files for proper formatting and/or against the schemas:
0 commit comments