/
CONTRIBUTING.md
134 lines (91 loc) · 4.11 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# Contributing guide
## Prerequisites
### Visual Studio Code
- [common extensions](https://command-line-interface-pages.github.io/site.github.io/extensions/)
- YAML:
- [YAML (linter, formatter, intellisence, snippets)][yaml-extension]
If you prefer [GitHub Actions][github-actions-extension] extension over this
one, it's possible to disable YAML extension for workflow files via:
```json
{
"yaml.schemas": {
"schemas/empty.json": ".github/workflows/*.yaml"
}
}
```
where **empty.json** is a schema with:
```json
{}
```
content.
- Hugo:
- [Hugo Language and Syntax Support (snippets, highlighting)][hugo-language-and-syntax-support-snippets-highlighting-extension]
[yaml-extension]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
[github-actions-extension]: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions
[hugo-language-and-syntax-support-snippets-highlighting-extension]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
## How to get started?
Before writing your own pages try to explore existing ones with preinstalled
prerequisites. Start with the [simplest](./content/goals.md) one.
### How to add a repository to the [home page][home]?
Public repositories are not listed automatically based on our organization.
It's manually chosen what to show and what not. To add a new repository to
the repository list:
- Open [`data/repositories.yaml`](./data/repositories.yaml) file
- Add a new array item like:
```yaml
cli-pages: # A repository
description: Command Line Interface (CLI) pages
```
[home]: https://command-line-interface-pages.github.io/site.github.io/
### How to add a similar project to the [project page][projects]?
To add a new similar project to the project list:
- Open [`data/projects.yaml`](./data/projects.yaml) file
- Add a new array item like:
```yaml
eg: # A similar project
description: Useful examples at the command line
url: https://github.com/srsudar/eg
```
[projects]: https://command-line-interface-pages.github.io/site.github.io/projects/
### How to add a common extension to the [extension page][extensions]?
To add a new common extension to the extension list:
- Open [`data/extensions.yaml`](./data/extensions.yaml) file
- Add a new object like:
```yaml
Commit messages: # An extension category
commitlint: # A common extension
description: A VS Code extension that integrates commitlint
url: https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint
type: [linter]
```
[extensions]: https://command-line-interface-pages.github.io/site.github.io/extensions/
### How to add a common editor to the [editor page][editors]?
To add a new common editor to the editor list:
- Open [`data/editors.yaml`](./data/editors.yaml) file
- Add a new object like:
```yaml
Krita: # An editor
description: Free and open-source raster graphics editor.
url: https://krita.org/en/
```
[editors]: https://command-line-interface-pages.github.io/site.github.io/editors/
### How to add a project supporting this one to the [supported by list][support]?
To add a new common editor to the editor list:
- Open [`data/support.yaml`](./data/support.yaml) file
- Add a new object like:
```yaml
Cheatsheets: # A project
introduction_url: https://github.com/rstacruz/cheatsheets/pull/1953
mention_url: https://github.com/rstacruz/cheatsheets/pull/1961
```
[support]: https://command-line-interface-pages.github.io/site.github.io/about/#supported-by-
### How else can I help?
Now we don't have anybody in organization who understands HTML, CSS and
JavaScript and willing to close [opened issues][issues]
related to these languages. If you are an open-source contributor and want to
help us, go ahead and make PR. 😄
Thanks!
[issues]: https://github.com/command-line-interface-pages/site.github.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
## See also
- [Mike Dane: Hugo tutorials][mike_dane_playlist]
[mike_dane_playlist]: https://www.youtube.com/watch?v=qtIqKaDlqXo&list=PLLAZ4kZ9dFpOnyRlyS-liKL5ReHDcj4G3