diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c99847..f9d4a96 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,7 @@ Please note that this project is released with a [Contributor Code of Conduct][c 0. Make sure the tests pass on your machine: `script/cibuild` 0. Create a new branch: `git checkout -b my-branch-name` 0. Make your change, add tests, and make sure the tests still pass +0. Sign all your commits: `git commit -s`(for additional info about the sign-off, check out [the upstream documentation](https://github.com/cri-o/cri-o/blob/main/CONTRIBUTING.md#sign-your-prs)) 0. Push to your fork and [submit a pull request][pr] 0. Pat your self on the back and wait for your pull request to be reviewed and merged. diff --git a/index.md b/index.md index 45930cf..44df9b1 100755 --- a/index.md +++ b/index.md @@ -112,7 +112,7 @@ It is a lightweight alternative to using Docker, Moby or rkt as the runtime for * {:.contributor} IBM CRI-O is developed by maintainers and contributors from these companies and others. -It is a community-driven, open source project. Feedback, users, and of course, contributors, are always welcome via the [cri-o/cri-o](https://github.com/cri-o/cri-o) GitHub project. +It is a community-driven, open source project. Feedback, users, and of course, contributors, are always welcome via the [cri-o/cri-o](https://github.com/cri-o/cri-o) GitHub project. For more guidance on how to contribute, please see the Contribute section below. ## Architecture @@ -128,7 +128,7 @@ The architectural components are as follows: - After the rootfs has been created for the container, CRI-O generates an OCI runtime specification json file describing how to run the container using the OCI Generate tools. - CRI-O then launches an OCI Compatible Runtime using the specification to run the container proceses. The default OCI Runtime is runc. - Each container is monitored by a separate `conmon` process. The conmon process holds the `pty` of the PID1 of the container process. It handles logging for the container and records the exit code for the container process. -- Networking for the pod is setup through use of [CNI](https://github.com/containernetworking/cni), so any CNI plugin can be used with CRI-O. +- Networking for the pod is set up through use of [CNI](https://github.com/containernetworking/cni), so any CNI plugin can be used with CRI-O. ## Components @@ -176,12 +176,18 @@ situations. Container security separation policies are provided by a series of tools including SELinux, Capabilities, seccomp, and other security separation policies as specified in the OCI Specification. -### Contribute +## Contribute + +Join the CRI-O community with other users and contributors - whether you want to ask questions, report issues, submit pull requests, be a reviewer, help with documentation, improve our website, or write a blog post, we always welcome new members. For more guidance on how to contribute, please see the [**contributing guide**](https://github.com/cri-o/cri-o/blob/main/CONTRIBUTING.md). You can find us at: -- [GitHub](https://github.com/cri-o/cri-o) -- Slack: [Kubernetes](https://slack.k8s.io/) #crio +* [**GitHub**](https://github.com/cri-o/cri-o) - For discussions around issues/bugs and features, you can use the GitHub issues and PRs tracking system. +* **Slack: [Kubernetes](https://slack.k8s.io/) #crio** - For general questions, or discussions, please use our channel on the Kubernetes slack. +* [**Bi-weekly community meetings**](https://github.com/cri-o/cri-o/wiki/CRI-O-Weekly-Meeting) - A place for CRI-O contributors and stakeholders to chat about the latest and greatest CRI-O work happening, and ask questions. #"cri-o" Tweets + +### Other resources +Learn more about CRI-O from [different articles, videos, podcasts and tutorials](https://github.com/cri-o/cri-o/blob/main/awesome.md) that our community put together. \ No newline at end of file