Update documentation according to internal requirements (#445)

Author: spavlusieva

CONTRIBUTING.md

@@ -1,34 +1,70 @@
-# Contributing to the OCI Cloud Controller Manager
+# Contributing to this repository
 
-*Copyright (c) 2017 Oracle and/or its affiliates. All rights reserved.*
+We welcome your contributions! There are multiple ways to contribute.
 
-## Guidelines to raise a PR
+## Opening issues
 
-### Contributor Agreement
+For bugs or enhancement requests, please file a GitHub issue unless it's
+security related. When filing a bug remember that the better written the bug is,
+the more likely it is to be fixed. If you think you've found a security
+vulnerability, do not raise a GitHub issue and follow the instructions in our
+[security policy](./SECURITY.md).
 
-Pull requests can be made under
-[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
-(OCA).
-For pull requests to be accepted, the bottom of
-your commit message must have the following line using your name and
-e-mail address as it appears in the OCA Signatories list.
-```
+## Contributing code
+
+We welcome your code contributions. Before submitting code via a pull request,
+you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
+your commits need to include the following line using the name and e-mail
+address you used to sign the OCA:
+
+```text
 Signed-off-by: Your Name <you@example.org>
 ```
-This can be automatically added to pull requests by committing with:
-```
+
+This can be automatically added to pull requests by committing with `--sign-off`
+or `-s`, e.g.
+
+```text
 git commit --signoff
 ```
-**Only pull requests from committers that can be verified as having
-signed the OCA can be accepted.**
+
+Only pull requests from committers that can be verified as having signed the OCA
+can be accepted.
+
+## Pull request process
+
+1. Ensure there is an issue created to track and discuss the fix or enhancement
+   you intend to submit.
+1. Fork this repository.
+1. Create a branch in your fork to implement the changes. We recommend using
+   the issue number as part of your branch name, e.g. `1234-fixes`.
+1. Ensure that any documentation is updated with the changes that are required
+   by your change.
+1. Ensure that any samples are updated if the base image has been changed.
+1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
+   what your changes are meant to do and provide simple steps on how to validate.
+   your changes. Ensure that you reference the issue you created as well.
+1. We will assign the pull request to 2-3 people for review before it is merged.
 
 ### Commit Message
-* The commits message should prefix "External-ccm:" 
-* All commits should be squashed to a single commit before merging
 
-### Best Practices
+* The commits message should prefix "External-ccm:".
+* All commits should be squashed to a single commit before merging.  
+
+### Best Practices:
+
 * Follow the development guidelines [here](docs/development.md)
-* govet, golint, gofmt should pass on the PR
-* make targets "build" and "test" should be successful on the PR
-* E2E should be run on a self managed test cluster, you will have to create a test cluster with the image generated from your changes. Please follow E2E guide [here](test/e2e/cloud-provider-oci/README.md)
-* E2E tests should pass on 3 versions of kubernetes currently supported by the repo
+* `govet`, `golint`, `gofmt` should pass on the PR
+* Make targets "build" and "test" should be successful on the PR
+* E2E should be run on a self managed test cluster, you will have to create a test
+  cluster with the image generated from your changes.
+  Please follow E2E guide [here](test/e2e/cloud-provider-oci/README.md)
+* E2E tests should pass on 3 versions of kubernetes currently supported by the repo.
+
+## Code of conduct
+
+Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
+like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
+
+[OCA]: https://oca.opensource.oracle.com
+[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

LICENSE renamed to LICENSE.txt

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -164,11 +164,11 @@ If you think you've found a bug, please [raise an issue][3].
 
 ## Contributing
 
-`oci-cloud-controller-manager` is an open source project. See [CONTRIBUTING](CONTRIBUTING.md) for
-details.
+This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
 
-Oracle gratefully acknowledges the contributions to this project that have been made
-by the community.
+## Security
+
+Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
 
 ## Upcoming Releases
 
@@ -178,7 +178,7 @@ by the community.
 
 ## License
 
-Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2017, 2023 Oracle and/or its affiliates. All rights reserved.
 
 `oci-cloud-controller-manager` is licensed under the Apache License 2.0.
 

SECURITY.md

@@ -0,0 +1,38 @@
+# Reporting security vulnerabilities
+
+Oracle values the independent security research community and believes that
+responsible disclosure of security vulnerabilities helps us ensure the security
+and privacy of all our users.
+
+Please do NOT raise a GitHub Issue to report a security vulnerability. If you
+believe you have found a security vulnerability, please submit a report to
+[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
+some additional information on [how to report security vulnerabilities to Oracle][2].
+We encourage people who contact Oracle Security to use email encryption using
+[our encryption key][3].
+
+We ask that you do not use other channels or contact the project maintainers
+directly.
+
+Non-vulnerability related security issues including ideas for new or improved
+security features are welcome on GitHub Issues.
+
+## Security updates, alerts and bulletins
+
+Security updates will be released on a regular cadence. Many of our projects
+will typically release security fixes in conjunction with the
+Oracle Critical Patch Update program. Additional
+information, including past advisories, is available on our [security alerts][4]
+page.
+
+## Security-related information
+
+We will provide security related information such as a threat model, considerations
+for secure use, or any known security issues in our documentation. Please note
+that labs and sample code are intended to demonstrate a concept and may not be
+sufficiently hardened for production use.
+
+[1]: mailto:secalert_us@oracle.com
+[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
+[3]: https://www.oracle.com/security-alerts/encryptionkey.html
+[4]: https://www.oracle.com/security-alerts/