Merge pull request #45 from equinor/repo-info

Update information

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# How to contribute to this repo
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Proposing new features
+- Discussing the current state of the code
+- Submitting a fix
+
+This is how you should do it:
+
+Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including
+
+### For **bug report**  
+- A quick summary and/or background
+- Steps to reproduce
+   - Be specific!
+   - Give sample code if you can
+- What you expected would happen
+- What actually happens
+
+The team love thorough bug reports - no it's not a joke!
+
+### For **feature request**  
+- Brief description of the feature
+- What problem/issue will this solve
+- A sort of Definition of Done - "How should it look when finsihed"
+
+### When submitting a fix using a Pull Request (PR)  
+
+- Fork this repository from GitHub  
+- Once, you have a local copy (after forking) you can make edits to the code, make formatting changes, reorganise the code, add documentation etc …  
+- After you have made the changes, you have to create a pull request  
+
+We will review the pull request and if it appropriate and there are no clashes or vulnerabilities, it will be merged to the main code  
+
+Voila! you have contributed to a piece of software and the cycle repeats.

README.md

@@ -1,15 +1,22 @@
+[![Build Status](https://github.com/equinor/radix-image-builder/workflows/radix-image-builder-build/badge.svg)](https://github.com/equinor/radix-image-builder/actions?query=workflow%3Aradix-image-builder-build)
 # radix-image-builder
 
 The radix-image-builder gives radix-pipeline access to build the images using ACR build functionality.
 
 Build is done using Github actions. There are secrets defined for the actions to be able to push to radixdev, radixprod and radixus. These are the corresponding credentials for radix-cr-cicd-dev and radix-cr-cicd-prod service accounts
 
-[![Build Status](https://github.com/equinor/radix-image-builder/workflows/radix-image-builder-build/badge.svg)](https://github.com/equinor/radix-image-builder/actions?query=workflow%3Aradix-image-builder-build)
-
 ## Local testing
 
 use Makefile to test locally
 
 `make build` will build a new image of radix-image-builder and keep it locally
 
-`make test` will test the local radix-image-builder image by building the Dockerfile under `.test` and push this image to `radixdev` container registry
+`make test` will test the local radix-image-builder image by building the Dockerfile under `.test` and push this image to `radixdev` container registry
+
+## Contribution
+
+Want to contribute? Read our [contributing guidelines](./CONTRIBUTING.md)
+
+## Security
+
+This is how we handle [security issues](./SECURITY.md)

SECURITY.md

@@ -0,0 +1,18 @@
+# Security
+
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+We prefer all communications to be in English.