You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+9-33
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,12 @@
1
1
# Contributing
2
2
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
10
4
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.
12
6
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
15
8
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.
19
10
20
11
## Code of Conduct
21
12
@@ -24,30 +15,15 @@ Please maintain respectful communication in the issue queue, PR queue, and all o
24
15
25
16
## Contribution guidelines
26
17
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.
28
19
29
20
### Issues
30
21
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.
46
23
47
24
#### Issue Lifecycle
48
25
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.
51
27
52
28
1. Issue creation
53
29
2. Triage
@@ -65,9 +41,9 @@ contributing to the Open Application Model specification. All issue types follow
65
41
66
42
### How to Contribute a Patch
67
43
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:
69
45
70
-
1. Fork the repo, modify the specification to address the issue.
46
+
1. Fork the repo, modify the project to address the issue.
71
47
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).
72
48
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.
73
49
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.
[](https://twitter.com/intent/follow?screen_name=oam_dev)
7
7
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.
9
9
10
10
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.
11
11
@@ -15,6 +15,8 @@ _"Developers think in terms of application architecture, not of infrastructure."
15
15
16
16

17
17
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
+
18
20
### Why Open Application Model?
19
21
20
22
Managing applications without application context is hard:
@@ -29,21 +31,22 @@ In Open Application Model, we propose an app-centric approach instead:
29
31
- Clarity and extensibility - an open standard to modularize infrastructure capabilities into reusable pieces that adapts to your needs, not the other way around.
30
32
- Runtime agnostic - a consistent experience to deploy and operate your apps across on-prem clusters, cloud providers or even edge devices.
31
33
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.
33
37
34
38
|| Previous Releases | Latest Release | Working Draft |
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.
39
44
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
42
46
43
-
For `v0.1.x` releases:
44
-
-[Rudr](https://github.com/oam-dev/rudr): the reference implementation of OAM on Kubernetes.
47
+
### Copyrights
45
48
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.
47
50
48
51
### Milestones
49
52
@@ -66,4 +69,3 @@ One of the easiest ways to contribute is to participate in discussions. There ar
0 commit comments