Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dev guidence of consolidating code. #141

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug report
about: Create a bug report
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment ie: OCM version, Kubernetes version and provider:**

**Additional context**
Add any other context about the problem here.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Enhancement request
about: Create a enhancement request
title: ''
labels: enhancement
assignees: ''

---

**Describe the enhancement**
A clear and concise description of what the enhancement request is.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/other_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Other report
about: Non bug or enhancement related issue
title: ''
labels: ''
assignees: ''

---
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@

# Contributing guidelines

The ocm repo contains 4 core components:
* registration
* placement
* work
* registration-operator

Before 0.11.0, the 4 components has independent repos, now we are going through [the task of consolidating code](https://github.com/open-cluster-management-io/OCM/issues/128) to merge all code into this repo to gain all kinds of benifits.

We're contiously working on migrate code from `staging` folder to outside. Finally, the `staging` folder will be empty and removed.

Here is a table of the migration status:

| Component | Status |
| --- | --- |
| registration | staging |
| placement | staging |
| work | staging |
| registration-operator | staging |

Status:
* staging: the component is having all code in `staging` folder.
* mix: the component is having code in both `staging` and outside.
* done: the component is having all code outside `staging` folder and done of the migration.

If a component is in staging status, you need to contribute code under the `staging` folder.

## Terms

All contributions to the repository must be submitted under the terms of the [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Expand Down