From 9edd4c005d6dc5639223dc95dc84106d4363652f Mon Sep 17 00:00:00 2001 From: Cara Delia <85503753+caradelia@users.noreply.github.com> Date: Tue, 4 Feb 2025 14:48:36 -0500 Subject: [PATCH] Add communicy documents Update CONTRIBUTING.md Create CODE-OF-CONDUCT.md Create SECURITY.md Replaces: https://github.com/containers/ramalama/pull/737 Originally written by caradelia (Cara Delia) Signed-off-by: Daniel J Walsh --- .github/workflows/install_ramalama.yml | 4 +- CODE-OF-CONDUCT.md | 71 ++++++++++++++++++++++++++ CONTRIBUTING.md | 18 +++++-- SECURITY.md | 3 ++ docs/ramalama-info.1.md | 2 +- 5 files changed, 92 insertions(+), 6 deletions(-) create mode 100644 CODE-OF-CONDUCT.md create mode 100644 SECURITY.md diff --git a/.github/workflows/install_ramalama.yml b/.github/workflows/install_ramalama.yml index 9ed9bc7a..8c5d5f62 100644 --- a/.github/workflows/install_ramalama.yml +++ b/.github/workflows/install_ramalama.yml @@ -39,10 +39,10 @@ jobs: chmod +x install.sh sudo ./install.sh -l - - name: Ramalama info + - name: RamaLama info run: | ramalama info - - name: Ramalama info + - name: RamaLama pull run: | ramalama pull tinyllama diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 00000000..2e7921ec --- /dev/null +++ b/CODE-OF-CONDUCT.md @@ -0,0 +1,71 @@ +![Containers Logo](https://github.com/containers/common/blob/main/logos/containers-full-horiz.png) +## Containers Community Code of Conduct + +### Contributor Code of Conduct + +As contributors and maintainers of the projects under the [Containers](https://github.com/containers) repository, +and in the interest of fostering an open and welcoming community, we pledge to +respect all people who contribute through reporting issues, posting feature +requests, updating documentation, submitting pull requests or patches, and other +activities to any of the projects under the containers umbrella. These projects +include Buildah, Conmon, Image, Podman, RamaLama, Storage, Skopeo, et al. +as found [here](https://github.com/containers). + +We are committed to making participation in these projects a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery. +* Personal attacks. +* Trolling or insulting/derogatory comments. +* Public or private harassment. +* Publishing other's private information, such as physical or electronic addresses, + without explicit permission. +* Other unethical or unprofessional conduct. + +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. By adopting this Code of Conduct, project maintainers +commit themselves to fairly and consistently applying these principles to every aspect +of managing their project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team or teams if they are in multiple +projects. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a maintainer of the project, the Container Organization's Code of Conduct Mailing List ([List Members](#List-Members)), Dan Walsh , and/or Tom Sweeney . + + +### Containers Events Code of Conduct + +Containers events are working conferences intended for professional networking and collaboration in the +Containers community. Attendees are expected to behave according to professional standards and in accordance +with their employer's policies on appropriate workplace behavior. + +While at Containers events or related social networking opportunities, attendees should not engage in +discriminatory or offensive speech or actions regarding gender, sexuality, race, or religion. Speakers should +be especially aware of these concerns. + +The maintainers of the Containers projects do not condone any statements by speakers contrary to these standards. +The maintainers of the Containers projects reserves the right to deny entrance and/or eject from an event +(without refund) any individual found to be engaging in discriminatory or offensive speech or actions. + +Please bring any concerns to the immediate attention of a maintainer of the project, the Container Organization's Code of Conduct Mailing List ([List Members](#List-Members)), Dan Walsh , and/or Tom Sweeney . + +This Code of Conduct was adapted from the [CNCF Community Code of Conduct v1.0](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +### List Members + +| List Member | email | +| ------------ | ------ | +| Chris Evich | cevich@redhat.com | +| Dan Walsh | dwalsh@redhat.com | +| Lokesh Mandvekar | lsm5@redhat.com | +| Mohan Boddu | mboddu@redhat.com | +| Paul Holzinger | pholzing@redhat.com | +| Preethi Thomas | pthomas@redhat.com | +| Tom Sweeney | tsweeney@redhat.com | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fc331b9..1d4b2472 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,8 @@ Below summarizes the processes that we follow. * [Contributing To RamaLama](#contributing-to-ramalama) * [Submitting Pull Requests](#submitting-pull-requests) * [Communications](#communications) +* [Code of Conduct](#code-of-conduct) + ## Reporting Issues @@ -130,7 +132,7 @@ To set up `podman farm` you need to first have `podman` installed on systems wit podman farm build -t / -f path/to/Containerfile ./path/ ``` -Example using an Apple Silicon based machine as the workstation, and an Intel Linux machine as a remote host with IP 10.11.12.13: +Example using an Apple Silicon based machine as the workstation, and an Intel Linux machine as a remote host with IP 10.11.12.13: 1. Set up Podman Farm - @@ -276,9 +278,9 @@ The following git config settings can be used to add a pretty format for outputt ``` [core] - abbrev = 12 + abbrev = 12 [pretty] - fixes = Fixes: %h (\"%s\") + fixes = Fixes: %h (\"%s\") ``` ### Sign your PRs @@ -382,6 +384,16 @@ and [PRs](https://github.com/containers/ramalama/pulls) tracking system. +## Code of Conduct + +As contributors and maintainers of the projects under the [Containers](https://github.com/containers) repository, +and in the interest of fostering an open and welcoming community, we pledge to +respect all people who contribute through reporting issues, posting feature +requests, updating documentation, submitting pull requests or patches, and other +activities to any of the projects under the containers umbrella. The full code of conduct guidelines can be +found [here](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md). + + ### Bot Interactions The primary human-interface is through comments in pull-requests. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..0d30a672 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +## Security and Disclosure Information Policy for the RamaLama Project + +The RamaLama Project follows the [Security and Disclosure Information Policy](https://github.com/containers/common/blob/main/SECURITY.md) for the Containers Projects. diff --git a/docs/ramalama-info.1.md b/docs/ramalama-info.1.md index 40bdbc10..bdd856b3 100644 --- a/docs/ramalama-info.1.md +++ b/docs/ramalama-info.1.md @@ -26,7 +26,7 @@ The `Runtime` field indicates which backend engine is used to execute the AI mod - `llama.cpp`: Uses the llama.cpp library for model execution - `vllm`: Uses the vLLM library for model execution -The `Store` field indicates the directory path where Ramalama stores its persistent data, including downloaded models, configuration files, and cached data. By default, this is located in the user's local share directory. +The `Store` field indicates the directory path where RamaLama stores its persistent data, including downloaded models, configuration files, and cached data. By default, this is located in the user's local share directory. The `UseContainer` field indicates whether RamaLama will use containers or run the AI Models natively.