Skip to content

Commit 567bf7e

Browse files
committed
Update OAM with CNCF guidelines
1 parent 893db6d commit 567bf7e

File tree

4 files changed

+28
-120
lines changed

4 files changed

+28
-120
lines changed

CONTRIBUTING.md

+9-33
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,12 @@
11
# Contributing
22

3-
## Proposing Changes and LGTM Policy
4-
5-
To propose a change or ask a question, please open an issue in the issue queue before submitting a pull request (PR). All PRs must be reviewed and approved (LGTMed) by 2 maintainers before being merged. Maintainers are specified in the [OWNERS](OWNERS.md) file. Refer to to the contribution guidelines in this document for more details on the process for issues and PRs.
6-
7-
## CLA Requirement
8-
9-
This project welcomes contributions and suggestions. All contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant the community the rights to use your contribution.
3+
## Introduction
104

11-
## Specification subject to the Open Web Foundation Agreements
5+
The developing of Open Application Model is driven by KubeVela, in most cases, you should use KubeVela repository for contribution. This repository mainly accepts issues and PRs for API specification release planning and maintenance purposes.
126

13-
In addition, by making a contribution to specifications in this repository, you, on behalf of yourself, your employer, and its affiliates, are making those contributions subject to the obligations set forth in the [OWF Contributor License Agreement 1.0 - Copyright and Patent](http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owf-contributor-license-agreement-1-0---copyright-and-patent).
14-
Final specifications developed in this repository will be subject to the [Open Web Foundation Final Specification Agreement (“OWFa 1.0”)](http://www.openwebfoundation.org/legal/the-owf-1-0-agreements/owfa-1-0). OWFa 1.0 will be applied as follows:
7+
## Proposing Changes and LGTM Policy
158

16-
- The maintainer will notify all contributors to a designated specification in writing via provided contact information of the start of a 30 day review period, after which the specification will be subject to the OWFa 1.0.
17-
- During that 30 day period, contributors may provide written notice to the maintainer that the contributor is not making the forgoing commitment under OWFa 1.0 for the designated specification (“Exclusion”).
18-
- Upon the end of that 30 day notice period, those contributors who have not issued an Exclusion, on behalf of themselves, their employer, and its affiliates, will, without further action, be subject to the obligations set forth in the OWFa 1.0 for the designated specification.
9+
To propose a change or ask a question, please open an issue in the issue queue before submitting a pull request (PR). All PRs must be reviewed and approved (LGTMed) by 2 maintainers before being merged. Maintainers are specified in the [OWNERS](OWNERS.md) file. Refer to to the contribution guidelines in this document for more details on the process for issues and PRs.
1910

2011
## Code of Conduct
2112

@@ -24,30 +15,15 @@ Please maintain respectful communication in the issue queue, PR queue, and all o
2415

2516
## Contribution guidelines
2617

27-
The Open Application Model specification project accepts contributions via GitHub pull requests. The following section outlines the process for merging contributions to the spec.
18+
This repository accepts contributions via GitHub pull requests. The following section outlines the process for merging contributions to the spec.
2819

2920
### Issues
3021

31-
Issues are used as the primary method for tracking anything to do with the Open Application Model specification project.
32-
33-
#### Issue Types
34-
35-
There are three types of issues (each with their own corresponding [label](#labels)):
36-
37-
- **Discussion**: These are support or functionality inquiries that we want to have a record of for
38-
future reference. Depending on the discussion, these can turn into "Spec Change" issues.
39-
- **Proposal**: Used for items that propose a new ideas or functionality that require
40-
a larger discussion. This allows for feedback from others before a
41-
spec change is actually written. All issues that are proposals should
42-
both have a label and an issue title of "Proposal: [the rest of the title]." A proposal can become
43-
a "Spec Change" and does not require a milestone.
44-
- **Spec Change**: These track specific spec changes and ideas until they are complete. They can evolve
45-
from "Proposal" and "Discussion" items, or can be submitted individually depending on the size. Each spec change should be placed into a milestone.
22+
Issues are used as the primary method for tracking anything to do with the Open Application Model project.
4623

4724
#### Issue Lifecycle
4825

49-
The issue lifecycle is mainly driven by the core maintainers, but is good information for those
50-
contributing to the Open Application Model specification. All issue types follow the same general lifecycle. Differences are noted below.
26+
All issue types follow the same general lifecycle. Differences are noted below.
5127

5228
1. Issue creation
5329
2. Triage
@@ -65,9 +41,9 @@ contributing to the Open Application Model specification. All issue types follow
6541

6642
### How to Contribute a Patch
6743

68-
Like any good open source project, we use Pull Requests (PRs) to track code changes. To submit a change to the specification:
44+
We use Pull Requests (PRs) to track code changes. To submit a change to the project:
6945

70-
1. Fork the repo, modify the specification to address the issue.
46+
1. Fork the repo, modify the project to address the issue.
7147
2. Pick an open issue from the [issue list](https://github.com/oam-dev/spec/issues) and claim it in the comments. After approval fix the issue and send us a pull request (PR).
7248
3. Or you can create a new issue. A community member will get back to you and, if approved, you can fix the issue and send a pull request.
7349
4. Please go through our issue list first (open as well as closed) and make sure the issue you are reporting does not replicate an issue already reported. If you have issues on multiple pages, report them separately. Do not combine them into a single issue.

OWNERS.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Owners
22

3+
## Introduction
4+
5+
Maintainers of Open Application Model will be inherited directly in KubeVela project as KubeVela API maintainers.
6+
37
## Maintainers
48

59
This section lists all active maintainers:

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Open Application Model Specification
1+
# Open Application Model
22

33
[![Gitter](https://badges.gitter.im/oam-dev/community.svg)](https://gitter.im/oam-devcommunity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
44
[![License: MIT](https://img.shields.io/badge/License-OWF-yellow)](https://github.com/oam-dev/spec/blob/master/LICENSE)
55
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/oam-dev/spec)](https://www.tickgit.com/browse?repo=github.com/oam-dev/spec)
66
[![Follow on Twitter](https://img.shields.io/twitter/follow/oam_dev.svg?style=social&logo=twitter)](https://twitter.com/intent/follow?screen_name=oam_dev)
77

8-
Open Application Model (OAM) is a runtime-agnostic specification for defining cloud native applications.
8+
Open Application Model (OAM) is a runtime-agnostic model for defining cloud native applications.
99

1010
Focused on **application** rather than container or orchestrator, Open Application Model brings modular, extensible, and portable design for modeling application deployment with consistent higher level API. This is the key to enable simple yet robust application delivery workflow across hybrid environments including Kubernetes, cloud, or even IoT devices.
1111

@@ -15,6 +15,8 @@ _"Developers think in terms of application architecture, not of infrastructure."
1515

1616
![How it works](assets/how-it-works.png)
1717

18+
Open Application Model is essentially the theoretical model behind [KubeVela](https://github.com/oam-dev/kubevela) project - a modern application deployment platform that makes delivering and managing applications across today's hybrid, multi-cloud environments easier and faster.
19+
1820
### Why Open Application Model?
1921

2022
Managing applications without application context is hard:
@@ -29,21 +31,22 @@ In Open Application Model, we propose an app-centric approach instead:
2931
- Clarity and extensibility - an open standard to modularize infrastructure capabilities into reusable pieces that adapts to your needs, not the other way around.
3032
- Runtime agnostic - a consistent experience to deploy and operate your apps across on-prem clusters, cloud providers or even edge devices.
3133

32-
## Read the specification
34+
## Learn the model
35+
36+
The developing and releasing of Open Application Model are all driven by KubeVela. Though the model itself is maintained as a set of API specifications in this repository. This enables some user cases where Kubernetes as control plane (required by KubeVela) is impossible but still want to adopt OAM.
3337

3438
| | Previous Releases | Latest Release | Working Draft |
3539
| :----------------------------: | :-----------------: | :------------: |:--------------------------------: |
36-
| OAM Specification | [v0.1.0](https://github.com/oam-dev/spec/releases/tag/v0.1.0), [v0.2.1](https://github.com/oam-dev/spec/releases/tag/v0.2.1) | [v0.3.0](SPEC.md) | -- |
40+
| OAM releases | [v0.2.1](https://github.com/oam-dev/spec/releases/tag/v0.2.1) | [v0.3.0](SPEC.md) | -- |
41+
| KubeVela releases | v0.3.x |v1.x | -- |
3742

38-
## See it in action
43+
For [v0.1.0](https://github.com/oam-dev/spec/releases/tag/v0.1.0) release of OAM, it is an experimental version only supported in [Rudr](https://github.com/oam-dev/rudr) and now archived.
3944

40-
For latest releases (recommend):
41-
- [KubeVela](https://github.com/oam-dev/kubevela): the modern application deployment system based on OAM, with Kubernetes as control plane.
45+
## Community
4246

43-
For `v0.1.x` releases:
44-
- [Rudr](https://github.com/oam-dev/rudr): the reference implementation of OAM on Kubernetes.
47+
### Copyrights
4548

46-
## Community
49+
The Open Application Model and KubeVela projects are hosted in [Cloud Native Computing Foundation (CNCF)](https://cncf.io). All copyrights belong to CNCF.
4750

4851
### Milestones
4952

@@ -66,4 +69,3 @@ One of the easiest ways to contribute is to participate in discussions. There ar
6669
| Bi-weekly APAC Friendly Meeting (Chinese)| [Zoom](https://us02web.zoom.us/j/2804785490?pwd=ZTN4ZU03UTlBZzlmVHIwTndINGM3UT09), [Meeting Notes](https://shimo.im/docs/w8CgdyYGWjtYJ3XP), [Records (BiliBili)](https://space.bilibili.com/180074935?spm_id_from=333.788.b_765f7570696e666f.2) |
6770
| IM Channel | https://gitter.im/oam-dev/ |
6871
| Twitter | [@oam_dev](https://twitter.com/oam_dev) |
69-

code-of-conduct.md

+2-76
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,3 @@
1-
# Open Application Model Code of Conduct
2-
3-
## Our Pledge
4-
5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to make participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
11-
12-
## Our Standards
13-
14-
Examples of behavior that contributes to creating a positive environment
15-
include:
16-
17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
22-
23-
Examples of unacceptable behavior by participants include:
24-
25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
33-
34-
## Our Responsibilities
35-
36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
39-
40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
45-
46-
## Scope
47-
48-
This Code of Conduct applies within all project spaces, and it also applies when
49-
an individual is representing the project or its community in public spaces.
50-
Examples of representing a project or community include using an official
51-
project e-mail address, posting via an official social media account, or acting
52-
as an appointed representative at an online or offline event. Representation of
53-
a project may be further defined and clarified by project maintainers.
54-
55-
## Enforcement
56-
57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team [TBD]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
63-
64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
67-
68-
## Attribution
69-
70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72-
73-
[homepage]: https://www.contributor-covenant.org
74-
75-
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
1+
# Code of Conduct
772

3+
Open Application Model follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

0 commit comments

Comments
 (0)