Skip to content

Commit c9bfbe9

Browse files
nithyatsunithyatsu
committed
add docs
1 parent 51dccef commit c9bfbe9

File tree

6 files changed

+226
-17
lines changed

6 files changed

+226
-17
lines changed

‎CODE_OF_CONDUCT.md

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Preamble
4+
5+
The Radius project seeks to foster an open, innovative, and inclusive community. To clarify expected behavior in our communities we have adopted the [Contributor Covenant](http://contributor-covenant.org/). This code of conduct has been adopted by [many other open source communities](http://contributor-covenant.org/adopters/) and we feel it expresses our values well. This applies to all interactions using official Radius project resources including all GitHub repositories.
6+
7+
## Our Pledge
8+
9+
We as members, contributors, and leaders pledge to make participation in our
10+
community a harassment-free experience for everyone, regardless of age, body
11+
size, visible or invisible disability, ethnicity, sex characteristics, gender
12+
identity and expression, level of experience, education, socio-economic status,
13+
nationality, personal appearance, race, religion, or sexual identity
14+
and orientation.
15+
16+
We pledge to act and interact in ways that contribute to an open, welcoming,
17+
diverse, inclusive, and healthy community.
18+
19+
## Our Standards
20+
21+
Examples of behavior that contributes to a positive environment for our
22+
community include:
23+
24+
* Demonstrating empathy and kindness toward other people
25+
* Being respectful of differing opinions, viewpoints, and experiences
26+
* Giving and gracefully accepting constructive feedback
27+
* Accepting responsibility and apologizing to those affected by our mistakes,
28+
and learning from the experience
29+
* Focusing on what is best not just for us as individuals, but for the
30+
overall community
31+
32+
Examples of unacceptable behavior include:
33+
34+
* The use of sexualized language or imagery, and sexual attention or
35+
advances of any kind
36+
* Trolling, insulting or derogatory comments, and personal or political attacks
37+
* Public or private harassment
38+
* Publishing others' private information, such as a physical or email
39+
address, without their explicit permission
40+
* Other conduct which could reasonably be considered inappropriate in a
41+
professional setting
42+
43+
## Enforcement Responsibilities
44+
45+
Community leaders are responsible for clarifying and enforcing our standards of
46+
acceptable behavior and will take appropriate and fair corrective action in
47+
response to any behavior that they deem inappropriate, threatening, offensive,
48+
or harmful.
49+
50+
Community leaders have the right and responsibility to remove, edit, or reject
51+
comments, commits, code, wiki edits, issues, and other contributions that are
52+
not aligned to this Code of Conduct, and will communicate reasons for moderation
53+
decisions when appropriate.
54+
55+
## Scope
56+
57+
This Code of Conduct applies within all community spaces, and also applies when
58+
an individual is officially representing the community in public spaces.
59+
Examples of representing our community include using an official e-mail address,
60+
posting via an official social media account, or acting as an appointed
61+
representative at an online or offline event.
62+
63+
## Enforcement
64+
65+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
66+
reported to the community leaders responsible for enforcement at
67+
[email protected]
68+
All complaints will be reviewed and investigated promptly and fairly.
69+
70+
All community leaders are obligated to respect the privacy and security of the
71+
reporter of any incident.
72+
73+
## Enforcement Guidelines
74+
75+
Community leaders will follow these Community Impact Guidelines in determining
76+
the consequences for any action they deem in violation of this Code of Conduct:
77+
78+
### 1. Correction
79+
80+
**Community Impact**: Use of inappropriate language or other behavior deemed
81+
unprofessional or unwelcome in the community.
82+
83+
**Consequence**: A private, written warning from community leaders, providing
84+
clarity around the nature of the violation and an explanation of why the
85+
behavior was inappropriate. A public apology may be requested.
86+
87+
### 2. Warning
88+
89+
**Community Impact**: A violation through a single incident or series
90+
of actions.
91+
92+
**Consequence**: A warning with consequences for continued behavior. No
93+
interaction with the people involved, including unsolicited interaction with
94+
those enforcing the Code of Conduct, for a specified period of time. This
95+
includes avoiding interactions in community spaces as well as external channels
96+
like social media. Violating these terms may lead to a temporary or
97+
permanent ban.
98+
99+
### 3. Temporary Ban
100+
101+
**Community Impact**: A serious violation of community standards, including
102+
sustained inappropriate behavior.
103+
104+
**Consequence**: A temporary ban from any sort of interaction or public
105+
communication with the community for a specified period of time. No public or
106+
private interaction with the people involved, including unsolicited interaction
107+
with those enforcing the Code of Conduct, is allowed during this period.
108+
Violating these terms may lead to a permanent ban.
109+
110+
### 4. Permanent Ban
111+
112+
**Community Impact**: Demonstrating a pattern of violation of community
113+
standards, including sustained inappropriate behavior, harassment of an
114+
individual, or aggression toward or disparagement of classes of individuals.
115+
116+
**Consequence**: A permanent ban from any sort of public interaction within
117+
the community.
118+
119+
## Attribution
120+
121+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
122+
version 2.0, available at
123+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
This Repository is part of Radius project. For general information please see [Radius](https://github.com/project-radius/radius)
4+
5+
## Table of contents
6+
7+
- [Building the repo](./docs/contributing/contributing-code/contributing-code-building/)
8+
- [Understanding repo organization](./docs/contributing/contributing-code/contributing-code-organization/)
9+
10+
## Current status
11+
12+
We welcome small pull request contributions from anyone (docs improvements, bug fixes, minor features.) as long as they follow a few guidelines:
13+
14+
- For very minor changes like correcting a typo feel free to send a pull request. Otherwise ...
15+
- Please start by [choosing an existing issue](https://github.com/project-radius/radius/issues), or [opening an issue](https://github.com/project-radius/radius/issues/new/choose) to work on.
16+
- The maintainers will respond to your issue, please work with the maintainers to ensure that what you're doing is in scope for the project before writing any code.
17+
- If you have any doubt whether a contribution would be valuable, feel free to ask.
18+
19+
## Code of conduct
20+
21+
This project has adopted the [Contributor Covenant](http://contributor-covenant.org/).
22+
For more information see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

‎README.md

+10-17
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
1-
# Summary
1+
# Bicep AWS Types
22

33
This repo contains the tooling for Bicep support for AWS types. The tools in this repository can be used to:
44

55
- List AWS's supported resource types using their native schema format
66
- Convert AWS's native schema format to Bicep's schema format
77

8-
## Contents
8+
## Summary
99

10-
- `/artifacts/types`: contains a dump of AWS's types
11-
- `/artifacts/bicep`: contains the Bicep schema output to be used by the compiler
12-
- `/src/aws-type-downloader`: updates the dump of AWS's types in `/artifacts/types`
13-
- `/src/aws-type-generator`: generates Bicep schema from `/artifacts/types` and updates `/artifacts/bicep`
10+
Browse our guides for how to [understand the code](./contributing-code/contributing-code-organization/)
11+
and [build the code](./contributing-code/contributing-code-building/).
12+
For information on how to contribute to Radius visit [Contributing](https://docs.radapp.dev/contributing/).
13+
For any other general information on Radius Visit [Radius](https://github.com/project-radius/radius)
1414

15-
We **check-in** the generated assets so we can easily visualize the differences when changes are made. Also, this means it's possible to iterate on `aws-type-generator` without an AWS account.
15+
## Security
1616

17-
## Prerequisites
17+
Please refer to our guide on [Reporting security vulnerabilities](SECURITY.md)
1818

19-
- Go 1.18
20-
- node/npm 14+
19+
## Code of conduct
2120

22-
## Instructions
21+
Please refer to our [Radius community code of conduct](CODE_OF_CONDUCT.md)
2322

24-
1. Clone this repository
25-
2. [Configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
26-
3. Run `go run ./src/aws-type-downloader/main.go --output ./artifacts/types --clean`
27-
4. Run `npm run --prefix ./src/aws-type-generator start -- --input ../../artifacts/types --output ../../artifacts/bicep`
28-
29-
Note: `npm run --prefix` does not preserve the current working directory, so the extra `../..` is needed.

‎SECURITY.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Security
2+
3+
The Radius maintainers take the security of our project seriously, which includes all source code repositories managed through our GitHub organization.
4+
5+
If you believe you have found a security vulnerability in any Radius repository, please report it to us as described below.
6+
7+
## Reporting Security Issues
8+
9+
**Please do not report security vulnerabilities through public GitHub issues.**
10+
11+
Instead, please report them to the [[email protected]](mailto:[email protected]).
12+
13+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
14+
15+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
16+
17+
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
18+
* Full paths of source file(s) related to the manifestation of the issue
19+
* The location of the affected source code (tag/branch/commit or direct URL)
20+
* Any special configuration required to reproduce the issue
21+
* Step-by-step instructions to reproduce the issue
22+
* Proof-of-concept or exploit code (if possible)
23+
* Impact of the issue, including how an attacker might exploit the issue
24+
25+
This information will help us triage your report more quickly.
26+
27+
## Preferred Languages
28+
29+
We prefer all communications to be in English.

‎docs/contributing/contributing-code/contributing-code-building/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Building the repository
2+
3+
## Prerequisites
4+
5+
Please make sure to have the below prerequisites installed for building this repository
6+
- Go 1.18
7+
- node/npm 14+
8+
9+
## Instructions
10+
11+
Once you have the prerequisites installed, you can build the repository with below instructions:
12+
13+
1. Clone this repository
14+
2. [Configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
15+
3. Run `go run ./src/aws-type-downloader/main.go --output ./artifacts/types --clean`
16+
4. Run `npm run --prefix ./src/aws-type-generator start -- --input ../../artifacts/types --output ../../artifacts/bicep`
17+
18+
Note: `npm run --prefix` does not preserve the current working directory, so the extra `../..` is needed.

‎docs/contributing/contributing-code/contributing-code-organization/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Understanding Bicep-Types-AWS repo code organization
2+
3+
This document describes the high-level organization of code for the Radius repository. The goal of this document is to capture most of the important details, not every single thing will be described here.
4+
5+
In general you should ask for guidance before creating a new top-level folder in the repo or creating a new folder in `pkg/`. There is usually a better place to put something.
6+
7+
8+
## Root Folders
9+
10+
| Folder | Description |
11+
| --------------------------- | --------------------------------------------------------------------------------------|
12+
| `/artifacts/types` | contains a dump of AWS's types |
13+
| `/artifacts/bicep` | contains the Bicep schema output to be used by the compiler |
14+
| `/src/aws-type-downloader` | updates the dump of AWS's types in `/artifacts/types` |
15+
| `/src/aws-type-generator` | generates Bicep schema from `/artifacts/types` and updates `/artifacts/bicep` |
16+
17+
18+
We **check-in** the generated assets so we can easily visualize the differences when changes are made. Also, this means it's possible to iterate on `aws-type-generator` without an AWS account.

0 commit comments

Comments
 (0)