Skip to content

Commit 73e1423

Browse files
committed
Added contributing.md
Added security.md Updated readme.md
1 parent d330a83 commit 73e1423

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# How to contribute to this repo
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Proposing new features
7+
- Discussing the current state of the code
8+
- Submitting a fix
9+
10+
This is how you should do it:
11+
12+
Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including
13+
14+
### For **bug report**
15+
- A quick summary and/or background
16+
- Steps to reproduce
17+
- Be specific!
18+
- Give sample code if you can
19+
- What you expected would happen
20+
- What actually happens
21+
22+
The team love thorough bug reports - no it's not a joke!
23+
24+
### For **feature request**
25+
- Brief description of the feature
26+
- What problem/issue will this solve
27+
- A sort of Definition of Done - "How should it look when finsihed"
28+
29+
### When submitting a fix using a Pull Request (PR)
30+
31+
- Fork this repository from GitHub
32+
- Once, you have a local copy (after forking) you can make edits to the code, make formatting changes, reorganise the code, add documentation etc …
33+
- After you have made the changes, you have to create a pull request
34+
35+
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
36+
37+
Voila! you have contributed to a piece of software and the cycle repeats.

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ We are using the [cobra framework](https://github.com/spf13/cobra) for handling
135135
cobra add <commandName>
136136
```
137137

138+
### Contributing
139+
140+
Want to [contribute](./CONTRIBUTING.md)?
141+
138142
### Generate client stubs
139143

140144
Client code is generated from swagger contract definition of the latest contract of the Radix API server. We use [go-swagger](https://github.com/go-swagger/go-swagger/blob/master/docs/install.md). Install it by:
@@ -170,3 +174,5 @@ CGO_ENABLED=0 GOOS=darwin go build -ldflags "-s -w" -a -installsuffix cgo -o ./r
170174
### Security
171175

172176
There is an app registration associated with the Radix CLI, `Omnia Radix CLI`, with API permissions to `Omnia Radix Web Console - Platform Clusters` to allow for the device code flow when running in interactive mode
177+
178+
Read this [Security information](./security.md)

SECURITY.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# How to manage security in this repo
2+
3+
If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
4+
5+
1. **Do not** create a public GitHub issue for the vulnerability.
6+
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
7+
8+
The following information will help us triage your report more quickly:
9+
10+
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
11+
- Full paths of source file(s) related to the manifestation of the issue
12+
- The location of the affected source code (tag/branch/commit or direct URL)
13+
- Any special configuration required to reproduce the issue
14+
- Step-by-step instructions to reproduce the issue
15+
- Proof-of-concept or exploit code (if possible)
16+
- Impact of the issue, including how an attacker might exploit the issue
17+
18+
We prefer all communications to be in English.

0 commit comments

Comments
 (0)