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
{{ message }}
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/how_to_contribute.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Clear Linux OS is composed of many different open source software projects and w
6
6
7
7
Before contributing, please review and abide by the [Code of Conduct](https://01.org/blogs/2018/intel-covenant-code).
8
8
9
-
Ensure any contributions align with Clear Linux philosophies on [stateless](https://clearlinux.org/features/stateless) and [security](https://docs.01.org/clearlinux/latest/guides/clear/security.html).
9
+
Ensure any contributions align with Clear Linux philosophies on [stateless](https://github.com/clearlinux/clear-linux-documentation/blob/master/source/guides/clear/stateless.rst) and [security](https://github.com/clearlinux/clear-linux-documentation/blob/master/source/guides/clear/security.rst).
10
10
11
11
More information on general Clear Linux OS constribution guidelines on [distribution guide](https://github.com/clearlinux/distribution/blob/master/contributing.md)
12
12
@@ -16,7 +16,7 @@ Swupd is open for code contributions. Nevertheless, if you are planning to propo
16
16
17
17
When your code is ready, open a pull request to have your patches reviewed. Patches are only going to be merged after being reviewed and approved by at least 2 maintainers (with some exceptions for trivial patches), all functional tests passes and enough tests are added to test the proposed functionality or bug fix. Make sure your [git user.name](https://help.github.com/en/articles/setting-your-username-in-git) and [git user.email](https://help.github.com/en/articles/setting-your-commit-email-address-in-git) are set correctly.
18
18
19
-
You should also add tests to the feature or bug fix you are proposing. That's how we ensure we won't have software regressions or we won't break any functionality in the future. For more information about function tests, take a look at the [functional test documentation](test/functional/README.md).
19
+
You should also add tests to the feature or bug fix you are proposing. That's how we ensure we won't have software regressions or we won't break any functionality in the future. For more information about function tests, take a look at the [functional test documentation](https://github.com/clearlinux/swupd-client/blob/master/test/functional/README.md).
20
20
21
21
## Error handling
22
22
@@ -68,17 +68,17 @@ Avoid extremely long lines. Don't use lines longer than 80~100 characters.
68
68
69
69
When writing functions that return a code consider the following guidelines:
70
70
71
-
- swupd should always exit with a [swupd code](src/swupd_exit_codes.h).
71
+
- swupd should always exit with a [swupd code](https://github.com/clearlinux/swupd-client/blob/master/src/swupd_exit_codes.h).
72
72
- When a function returns a boolean state, prefer to explicitly return *true*/*false* instead of returning *0*/*1*.
73
73
- Avoid using a *"catch all"* error in your code that would make harder debugging a failure.
74
-
- Internally, swupd functions can return values other than a [swupd code](src/swupd_exit_codes.h) as long as those values are not propagated all the way to the end user.
74
+
- Internally, swupd functions can return values other than a [swupd code](https://github.com/clearlinux/swupd-client/blob/master/src/swupd_exit_codes.h) as long as those values are not propagated all the way to the end user.
75
75
For example a function could return an error defined in any of these files:
76
76
- /usr/include/asm-generic/errno-base.h
77
77
- /usr/include/asm-generic/errno.h
78
78
- /usr/include/curl/curl.h
79
79
80
80
## Swupd generic library
81
81
82
-
Library on [src/lib](src/lib) was created to group the implementation of
82
+
Library on [src/lib](https://github.com/clearlinux/swupd-client/tree/master/src/lib) was created to group the implementation of
83
83
generic data types, helpers and system interaction used by swupd, but without
0 commit comments