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: CONTRIBUTING.md
+42-9Lines changed: 42 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,8 +72,8 @@ license.
72
72
### Commit Sign-Off
73
73
74
74
Every commit must be signed off. That is, every commit log message
75
-
must include a “`Signed-off-by`” line (generated, for example, with
76
-
“`git commit --signoff`”), indicating that the committer wrote the
75
+
must include a "`Signed-off-by`" line (generated, for example, with
76
+
"`git commit --signoff`"), indicating that the committer wrote the
77
77
code and has the right to release it under the [Apache-2.0](LICENSE.md)
78
78
license. See [Contribution Sign-Off](https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contribution-sign-off)
79
79
for more information on this requirement.
@@ -83,7 +83,7 @@ for more information on this requirement.
83
83
### Git Basics
84
84
85
85
Working with aswf-docker requires understanding a significant amount of
86
-
Git and GitHub based terminology. If you’re unfamiliar with these
86
+
Git and GitHub based terminology. If you're unfamiliar with these
87
87
tools or their lingo, please look at the [GitHub
88
88
Glossary](https://help.github.com/articles/github-glossary/) or browse
89
89
[GitHub Help](https://help.github.com/).
@@ -113,8 +113,8 @@ contributions should be done on top of it.
113
113
After sufficient work is done on the main branch and the aswf-docker
114
114
leadership determines that a release is due, we will bump the relevant
115
115
internal versioning and tag a commit with the corresponding version
116
-
number, e.g. v2.0.1. Each Minor version also has its own “Release
117
-
Branch”, e.g. RB-1.1. This marks a branch of code dedicated to that
116
+
number, e.g. v2.0.1. Each Minor version also has its own "Release
117
+
Branch", e.g. RB-1.1. This marks a branch of code dedicated to that
118
118
Major.Minor version, which allows upstream bug fixes to be
119
119
cherry-picked to a given version while still allowing the main
120
120
branch to continue forward onto higher versions. This basic repository
@@ -141,7 +141,7 @@ workflow.
141
141
142
142
In a typical workflow, you should **fork** the aswf-docker repository to
143
143
your account. This creates a copy of the repository under your user
144
-
namespace and serves as the “home base” for your development branches,
144
+
namespace and serves as the "home base" for your development branches,
145
145
from which you will submit **pull requests** to the upstream
146
146
repository to be merged.
147
147
@@ -291,9 +291,20 @@ Use the existing recipes as an example, and borrow from the MIT-licensed
291
291
Follow the great instructions there:
292
292
[Conan Center Index - How to add Packages](https://github.com/conan-io/conan-center-index/blob/master/docs/how_to_add_packages.md),
293
293
but ignore the `config.yml` instructions as the aswfdocker `versions.yaml` already
294
-
takes care of listing all the maintained package versions.
294
+
takes care of listing all the maintained package versions. If required `config.yml` can still be used when completely different recipes are require for
295
+
major package versions, see the `onetbb` package for an example.
295
296
296
-
Then ensure the ASWF-specific settings are added in the `conanfile.py` such as `python`. This project attempts to minimize local changes to the recipes which originate in the Conan Center Index. Local changes may be marked with a `# ASWF` comment. For simple recipes, the required changes may be as minimal as:
297
+
Then ensure the ASWF-specific settings are added in the `conanfile.py` such as `cpython`. This project attempts to minimize local changes to the recipes which originate in the Conan Center Index. Local changes may be marked with a `# ASWF` comment. For simple recipes, the required changes may be as minimal as:
298
+
299
+
- adding a [SPDX license header](https://spdx.dev/learn/handling-license-info/) where the `From:` URL can be obtained by using the `y` hotkey in the GitHub web UI to obtain a permalink to the version of the Conan recipe file
300
+
you are basing hyour local copy on.
301
+
```
302
+
# Copyright (c) Contributors to the conan-center-index Project. All rights reserved.
303
+
# Copyright (c) Contributors to the aswf-docker Project. All rights reserved.
- adding a line to the `layout()` method to adhere to the Enterprise Linux convention of storing 64 bit libraries in the `lib64` directory rather than Conan's default `lib`:
299
310
```
@@ -354,6 +365,28 @@ The `--keep-source` and `--keep-build` can help when iterating on the build reci
354
365
avoid re-downloading the source, and even keep the previous build artifact.
355
366
All regular aswfdocker commands and options work the same with conan or docker packages.
356
367
368
+
You can use the `aswfdocker conandiff` command to view updates in the upstream Conan Center Index recipes since the last time the local copy was updated. This requires the `From: https://...` header comment to be updated correctly.
0 commit comments