@@ -17,7 +17,7 @@ help you resolve them.
17
17
OpenBMC relies on the Open Compute Project to provide guidelines on inclusive
18
18
naming. The OCP guidelines can be found here:
19
19
20
- https://www.opencompute.org/documents/ocp-terminology-guidelines-for-inclusion-and-openness
20
+ < https://www.opencompute.org/documents/ocp-terminology-guidelines-for-inclusion-and-openness >
21
21
22
22
## Structure
23
23
@@ -47,7 +47,7 @@ If you work for someone, consider asking them to execute the corporate CLA. This
47
47
allows other contributors that work for your employer to skip the CLA signing
48
48
process, they can just be added to the existing CCLA Schedule A.
49
49
50
- After signing a CLA, send it to
[email protected] .
50
+ After signing a CLA, send it to
< [email protected] > .
51
51
52
52
If you're looking for a place to get started with OpenBMC, you may want to take
53
53
a look at the issues tagged with 'bitesize'. These are fixes or enhancements
@@ -56,12 +56,12 @@ for a newcomer to start working with.
56
56
57
57
Check out that list here:
58
58
59
- https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Aopenbmc+label%3Abitesize
59
+ < https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Aopenbmc+label%3Abitesize >
60
60
61
61
If you need further details on any of these issues, feel free to add comments.
62
62
63
63
Performing code reviews is another good way to get started. Go to
64
- https://gerrit.openbmc.org and click on the "all" and "open" menu items, or if
64
+ < https://gerrit.openbmc.org > and click on the "all" and "open" menu items, or if
65
65
you are interested in a particular repository - for example, "bmcweb" - type
66
66
"status: open project: openbmc /bmcweb" into the search bar and press the "search"
67
67
button. Then select a review. Remember to be positive and add value with every
@@ -78,7 +78,7 @@ upstream project. Otherwise, conventions are chosen based on the language.
78
78
Python source should all conform to PEP8. This style is well established within
79
79
the Python community and can be verified with the 'pycodestyle' tool.
80
80
81
- https://www.python.org/dev/peps/pep-0008/
81
+ < https://www.python.org/dev/peps/pep-0008/ >
82
82
83
83
### Python Formatting
84
84
@@ -91,7 +91,7 @@ OpenBMC standards for Python match with PEP 8 so in general, a blank setup.cfg
91
91
file is all that's needed. If so desired, enforcement of 80 (vs. the default 79)
92
92
chars is fine as well:
93
93
94
- ```
94
+ ``` toml
95
95
[pycodestyle ]
96
96
max-line-length = 80
97
97
```
@@ -102,7 +102,7 @@ they are not unanimously accepted and PEP 8 does not enforce them. It is at the
102
102
repository maintainer's discretion as to whether to enforce the aforementioned
103
103
rules. These rules can be enforced by adding the following to the setup.cfg:
104
104
105
- ```
105
+ ``` toml
106
106
[pycodestyle ]
107
107
ignore = NONE
108
108
```
@@ -123,7 +123,7 @@ We follow the
123
123
124
124
For C code, we typically use the Linux coding style, which is documented at:
125
125
126
- http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst
126
+ < http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst >
127
127
128
128
In short:
129
129
@@ -135,7 +135,9 @@ In short:
135
135
136
136
This style can mostly be verified with 'astyle' as follows:
137
137
138
- astyle --style=linux --indent=tab=8 --indent=force-tab=8
138
+ ``` bash
139
+ astyle --style=linux --indent=tab=8 --indent=force-tab=8
140
+ ```
139
141
140
142
### C++
141
143
@@ -235,11 +237,13 @@ practice in many projects which use Git.
235
237
Exceptions to this are allowed in the form of links, which can be represented in
236
238
the form of:
237
239
238
- ''' This implements [ 1]
240
+ ``` markdown
241
+ This implements [1]
239
242
240
243
....
241
244
242
- [ 1] https://openbmc.org/myverylongurl . '''
245
+ [1]: https://openbmc.org/myverylongurl.
246
+ ```
243
247
244
248
All commit messages must include a "Signed-off-by" line, which indicates that
245
249
you the contributor have agreed to the Developer Certificate of Origin (see
@@ -258,7 +262,7 @@ different projects depend on each other).
258
262
Commit messages should include a "Tested" field describing how you tested the
259
263
code changes in the patch. Example:
260
264
261
- ```
265
+ ``` text
262
266
Tested: I ran unit tests with "make check" (added 2 new tests) and manually
263
267
tested on Witherspoon that Foo daemon no longer crashes at boot.
264
268
```
@@ -272,32 +276,31 @@ field.
272
276
273
277
The guidelines in the Linux kernel are very useful:
274
278
275
- https://www.kernel.org/doc/html/latest/process/submitting-patches.html
276
-
277
- https://www.kernel.org/doc/html/latest/process/submit-checklist.html
279
+ - < https://www.kernel.org/doc/html/latest/process/submitting-patches.html >
280
+ - < https://www.kernel.org/doc/html/latest/process/submit-checklist.html >
278
281
279
282
Your contribution will generally need to be reviewed before being accepted.
280
283
281
284
## Submitting changes via Gerrit server to OpenBMC
282
285
283
286
The OpenBMC Gerrit server supports GitHub credentials, its link is:
284
287
285
- https://gerrit.openbmc.org/#/q/status:open
288
+ < https://gerrit.openbmc.org/#/q/status:open >
286
289
287
290
_ One time setup_ : Login to the WebUI with your GitHub credentials and verify on
288
291
your Account Settings that your SSH keys were imported:
289
292
290
- https://gerrit.openbmc.org/#/settings/
293
+ < https://gerrit.openbmc.org/#/settings/ >
291
294
292
295
Most repositories are supported by the Gerrit server, the current list can be
293
296
found under Projects -> List:
294
297
295
- https://gerrit.openbmc.org/#/admin/projects/
298
+ < https://gerrit.openbmc.org/#/admin/projects/ >
296
299
297
300
If you're going to be working with Gerrit often, it's useful to create an SSH
298
301
host block in ~ /.ssh/config. Ex:
299
302
300
- ```
303
+ ``` text
301
304
Host openbmc.gerrit
302
305
Hostname gerrit.openbmc.org
303
306
Port 29418
@@ -325,7 +328,7 @@ to identify commits that belong to the same review. Configure your git
325
328
repository to automatically add a Change-Id to your commit messages. The steps
326
329
are:
327
330
328
- ```
331
+ ``` bash
329
332
gitdir=$( git rev-parse --git-dir)
330
333
curl https://gerrit.openbmc.org/tools/hooks/commit-msg -o ${gitdir} /hooks/commit-msg
331
334
chmod +x ${gitdir} /hooks/commit-msg`
@@ -381,9 +384,9 @@ no dependencies on non-public resources (URLs, repositories, etc).
381
384
382
385
- D-Bus interfaces are defined in the `phosphor-dbus-interfaces` repository at:
383
386
384
- https://github.com/openbmc/phosphor-dbus-interfaces
387
+ < https://github.com/openbmc/phosphor-dbus-interfaces>
385
388
386
- See: http://dbus.freedesktop.org/doc/dbus-api-design.html
389
+ See: < http://dbus.freedesktop.org/doc/dbus-api-design.html>
387
390
388
391
## Best practices for C
389
392
@@ -455,6 +458,7 @@ on its own.
455
458
456
459
## Developer' s Certificate of Origin 1.1
457
460
461
+ ` ` ` text
458
462
By making a contribution to this project, I certify that:
459
463
460
464
(a) The contribution was created in whole or in part by me and I
@@ -478,3 +482,4 @@ on its own.
478
482
personal information I submit with it, including my sign-off) is
479
483
maintained indefinitely and may be redistributed consistent with
480
484
this project or the open source license(s) involved.
485
+ ` ` `
0 commit comments