mirror of
https://github.com/apple/container.git
synced 2026-09-08 16:55:41 +00:00
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.
This commit is contained in:
Patrice Jaton
@@ -1,77 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our
|
||||
project and our community a harassment-free experience for everyone,
|
||||
regardless of age, body size, disability, ethnicity, sex
|
||||
characteristics, gender identity and expression, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance,
|
||||
race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual
|
||||
attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political
|
||||
attacks
|
||||
* Public or private harassment
|
||||
* Publishing others’ private information, such as a physical or
|
||||
electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of
|
||||
acceptable behavior and are expected to take appropriate and fair
|
||||
corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit,
|
||||
or reject comments, commits, code, wiki edits, issues, and other
|
||||
contributions that are not aligned to this Code of Conduct, or to ban
|
||||
temporarily or permanently any contributor for other behaviors that they
|
||||
deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all project spaces, and it also
|
||||
applies when an individual is representing the project or its community
|
||||
in public spaces. Examples of representing a project or community
|
||||
include using an official project e-mail address, posting via an
|
||||
official social media account, or acting as an appointed representative
|
||||
at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may
|
||||
be reported by contacting the open source team at
|
||||
opensource-conduct@group.apple.com. All complaints will be reviewed and
|
||||
investigated and will result in a response that is deemed necessary and
|
||||
appropriate to the circumstances. The project team is obligated to
|
||||
maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted
|
||||
separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in
|
||||
good faith may face temporary or permanent repercussions as determined
|
||||
by other members of the project’s leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the
|
||||
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
+15
-14
@@ -6,12 +6,13 @@ Contributions to Containerization are welcomed and encouraged.
|
||||
|
||||
We would love your contributions in the form of:
|
||||
|
||||
* 🐛 Bug fixes
|
||||
* ⚡️ Performance improvements
|
||||
* ✨ API additions or enhancements
|
||||
* 📝 Documentation
|
||||
* 🧑💻 Project advocacy: blogs, conference talks, and more
|
||||
* Anything else that could enhance the project!
|
||||
🐛 Bug fixes\
|
||||
⚡️ Performance improvements\
|
||||
✨ API additions or enhancements\
|
||||
📝 Documentation\
|
||||
🧑💻 Project advocacy: blogs, conference talks, and more
|
||||
|
||||
Anything else that could enhance the project!
|
||||
|
||||
## Submitting Issues and Pull Requests
|
||||
|
||||
@@ -19,11 +20,11 @@ We would love your contributions in the form of:
|
||||
|
||||
To file a bug or feature request, use [GitHub issues](https://github.com/apple/containerization/issues/new).
|
||||
|
||||
🚧 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.
|
||||
🚧 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.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
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!
|
||||
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!
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 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
|
||||
|
||||
Before merging, we'll review the pull request title and body to ensure it:
|
||||
|
||||
* Clearly and concisely describes the changes.
|
||||
* Uses the imperative mood (e.g., "Add feature," "Fix bug").
|
||||
* Provides enough context for future developers to understand the purpose of the change.
|
||||
* Clearly and concisely describes the changes.
|
||||
* Uses the imperative mood (e.g., "Add feature," "Fix bug").
|
||||
* Provides enough context for future developers to understand the purpose of the change.
|
||||
|
||||
The pull request description should be concise and accurately describe the *what* and *why* of your changes.
|
||||
|
||||
@@ -49,7 +50,7 @@ The pull request description should be concise and accurately describe the *what
|
||||
Make sure your contributions are consistent with the rest of the project's formatting. You can do this using our Makefile:
|
||||
|
||||
```bash
|
||||
$ make fmt
|
||||
make fmt
|
||||
```
|
||||
|
||||
#### Applying License Header to New Files
|
||||
@@ -57,9 +58,9 @@ $ make fmt
|
||||
If you submit a contribution that adds a new file, please add the license header. You can do this using our Makefile:
|
||||
|
||||
```bash
|
||||
$ make update-licenses
|
||||
make update-licenses
|
||||
```
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
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).
|
||||
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").
|
||||
|
||||
@@ -4,6 +4,7 @@ The Containerization package allows applications to use Linux containers.
|
||||
Containerization is written in [Swift](https://www.swift.org) and uses [Virtualization.framework](https://developer.apple.com/documentation/virtualization) on Apple Silicon.
|
||||
|
||||
Containerization provides APIs to:
|
||||
|
||||
- Manage OCI images.
|
||||
- Interact with remote registries.
|
||||
- Create and populate ext4 file systems.
|
||||
@@ -79,18 +80,21 @@ make cross-prep
|
||||
```
|
||||
|
||||
If you use a custom terminal application, you may need to move this command from `.zprofile` to `.zshrc` (replace `<USERNAME>`):
|
||||
|
||||
```bash
|
||||
# Added by swiftly
|
||||
. "/Users/<USERNAME>/.swiftly/env.sh"
|
||||
```
|
||||
|
||||
Restart the terminal application. Ensure this command returns `/Users/<USERNAME>/.swiftly/bin/swift` (replace `<USERNAME>`):
|
||||
|
||||
```bash
|
||||
which swift
|
||||
```
|
||||
|
||||
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>`):
|
||||
```
|
||||
|
||||
```bash
|
||||
swift sdk list
|
||||
swift sdk remove <SDK-ID>
|
||||
```
|
||||
@@ -124,6 +128,6 @@ Preview the documentation by running in another terminal:
|
||||
open http://localhost:8000/documentation/
|
||||
```
|
||||
|
||||
## Contributing
|
||||
## Contributing
|
||||
|
||||
Contributions to Containerization are welcomed and encouraged. Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# Security Disclosure Process
|
||||
# Security disclosure process
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user