Skip to content

Commit ca3c94a

Browse files
authored
Update documentations. (#26)
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.
1 parent fc4a124 commit ca3c94a

5 files changed

Lines changed: 22 additions & 94 deletions

File tree

CODE-OF-CONDUCT.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,25 @@ Contributions to Containerization are welcomed and encouraged.
66

77
We would love your contributions in the form of:
88

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!
1516

1617
## Submitting Issues and Pull Requests
1718

1819
### Issues
1920

2021
To file a bug or feature request, use [GitHub issues](https://github.com/apple/containerization/issues/new).
2122

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.
2324

2425
### Pull Requests
2526

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!
2728

2829
> [!IMPORTANT]
2930
> 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
3839

3940
Before merging, we'll review the pull request title and body to ensure it:
4041

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.
4445

4546
The pull request description should be concise and accurately describe the *what* and *why* of your changes.
4647

@@ -49,17 +50,17 @@ The pull request description should be concise and accurately describe the *what
4950
Make sure your contributions are consistent with the rest of the project's formatting. You can do this using our Makefile:
5051

5152
```bash
52-
$ make fmt
53+
make fmt
5354
```
5455

5556
#### Applying License Header to New Files
5657

5758
If you submit a contribution that adds a new file, please add the license header. You can do this using our Makefile:
5859

5960
```bash
60-
$ make update-licenses
61+
make update-licenses
6162
```
6263

6364
## Code of Conduct
6465

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").
File renamed without changes.

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ The Containerization package allows applications to use Linux containers.
44
Containerization is written in [Swift](https://www.swift.org) and uses [Virtualization.framework](https://developer.apple.com/documentation/virtualization) on Apple Silicon.
55

66
Containerization provides APIs to:
7+
78
- Manage OCI images.
89
- Interact with remote registries.
910
- Create and populate ext4 file systems.
@@ -79,18 +80,21 @@ make cross-prep
7980
```
8081

8182
If you use a custom terminal application, you may need to move this command from `.zprofile` to `.zshrc` (replace `<USERNAME>`):
83+
8284
```bash
8385
# Added by swiftly
8486
. "/Users/<USERNAME>/.swiftly/env.sh"
8587
```
8688

8789
Restart the terminal application. Ensure this command returns `/Users/<USERNAME>/.swiftly/bin/swift` (replace `<USERNAME>`):
90+
8891
```bash
8992
which swift
9093
```
9194

9295
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
9498
swift sdk list
9599
swift sdk remove <SDK-ID>
96100
```
@@ -124,6 +128,6 @@ Preview the documentation by running in another terminal:
124128
open http://localhost:8000/documentation/
125129
```
126130

127-
## Contributing
131+
## Contributing
128132

129133
Contributions to Containerization are welcomed and encouraged. Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Security Disclosure Process
1+
# Security disclosure process
22

33
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.
44

0 commit comments

Comments
 (0)