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
Some updates to the documentation:
* Replace code-of-conduct with organization one.
* Cleanup `CONTRIBUTING.md`, `README.md` and `SECURITY.md` markdown.
* Remove `.txt` extension from `LICENSE` for consistency across repos.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,25 @@ Contributions to Containerization are welcomed and encouraged.
6
6
7
7
We would love your contributions in the form of:
8
8
9
-
* 🐛 Bug fixes
10
-
* ⚡️ Performance improvements
11
-
* ✨ API additions or enhancements
12
-
* 📝 Documentation
13
-
* 🧑💻 Project advocacy: blogs, conference talks, and more
14
-
* Anything else that could enhance the project!
9
+
🐛 Bug fixes\
10
+
⚡️ Performance improvements\
11
+
✨ API additions or enhancements\
12
+
📝 Documentation\
13
+
🧑💻 Project advocacy: blogs, conference talks, and more
14
+
15
+
Anything else that could enhance the project!
15
16
16
17
## Submitting Issues and Pull Requests
17
18
18
19
### Issues
19
20
20
21
To file a bug or feature request, use [GitHub issues](https://github.com/apple/containerization/issues/new).
21
22
22
-
🚧 For unexpected behavior or usability limitations, detailed instructions on how to reproduce the issue are appreciated. This will greatly help the priority setting and speed of which maintainers can get to your issue.
23
+
🚧 For unexpected behavior or usability limitations, detailed instructions on how to reproduce the issue are appreciated. This will greatly help the priority setting and speed of which maintainers can get to your issue.
23
24
24
25
### Pull Requests
25
26
26
-
To make a pull request, use [GitHub](https://github.com/apple/containerization/compare). Please give the team a few days to review but it's ok to check in on occassion. We appreciate your contribution!
27
+
To make a pull request, use [GitHub](https://github.com/apple/containerization/compare). Please give the team a few days to review but it's ok to check in on occassion. We appreciate your contribution!
27
28
28
29
> [!IMPORTANT]
29
30
> If you plan to make substantial changes or add new features, we encourage you to first discuss them with the wider containerization developer community.
@@ -38,9 +39,9 @@ for the squashed commit. Think of it as the single, definitive description of yo
38
39
39
40
Before merging, we'll review the pull request title and body to ensure it:
40
41
41
-
*Clearly and concisely describes the changes.
42
-
*Uses the imperative mood (e.g., "Add feature," "Fix bug").
43
-
*Provides enough context for future developers to understand the purpose of the change.
42
+
* Clearly and concisely describes the changes.
43
+
* Uses the imperative mood (e.g., "Add feature," "Fix bug").
44
+
* Provides enough context for future developers to understand the purpose of the change.
44
45
45
46
The pull request description should be concise and accurately describe the *what* and *why* of your changes.
46
47
@@ -49,17 +50,17 @@ The pull request description should be concise and accurately describe the *what
49
50
Make sure your contributions are consistent with the rest of the project's formatting. You can do this using our Makefile:
50
51
51
52
```bash
52
-
$ make fmt
53
+
make fmt
53
54
```
54
55
55
56
#### Applying License Header to New Files
56
57
57
58
If you submit a contribution that adds a new file, please add the license header. You can do this using our Makefile:
58
59
59
60
```bash
60
-
$ make update-licenses
61
+
make update-licenses
61
62
```
62
63
63
64
## Code of Conduct
64
65
65
-
To clarify of what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](/CODE-OF-CONDUCT.MD).
66
+
To clarify of what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](https://github.com/apple/.github/blob/main/CODE_OF_CONDUCT.md"Code of Conduct").
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ The Containerization package allows applications to use Linux containers.
4
4
Containerization is written in [Swift](https://www.swift.org) and uses [Virtualization.framework](https://developer.apple.com/documentation/virtualization) on Apple Silicon.
5
5
6
6
Containerization provides APIs to:
7
+
7
8
- Manage OCI images.
8
9
- Interact with remote registries.
9
10
- Create and populate ext4 file systems.
@@ -79,18 +80,21 @@ make cross-prep
79
80
```
80
81
81
82
If you use a custom terminal application, you may need to move this command from `.zprofile` to `.zshrc` (replace `<USERNAME>`):
83
+
82
84
```bash
83
85
# Added by swiftly
84
86
."/Users/<USERNAME>/.swiftly/env.sh"
85
87
```
86
88
87
89
Restart the terminal application. Ensure this command returns `/Users/<USERNAME>/.swiftly/bin/swift` (replace `<USERNAME>`):
90
+
88
91
```bash
89
92
which swift
90
93
```
91
94
92
95
If you've installed or used a Static Linux SDK previously, you may need to remove older SDK versions from the system (replace `<SDK-ID>`):
93
-
```
96
+
97
+
```bash
94
98
swift sdk list
95
99
swift sdk remove <SDK-ID>
96
100
```
@@ -124,6 +128,6 @@ Preview the documentation by running in another terminal:
124
128
open http://localhost:8000/documentation/
125
129
```
126
130
127
-
## Contributing
131
+
## Contributing
128
132
129
133
Contributions to Containerization are welcomed and encouraged. Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
Copy file name to clipboardExpand all lines: SECURITY.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Security Disclosure Process
1
+
# Security disclosure process
2
2
3
3
If you believe that you have discovered a security or privacy vulnerability in our open source software, please report it to us using the [GitHub private vulnerability feature](https://github.com/apple/containerization/security/advisories/new). Reports should include specific product and software version(s) that you believe are affected; a technical description of the behavior that you observed and the behavior that you expected; the steps required to reproduce the issue; and a proof of concept or exploit.
0 commit comments