Skip to content

Commit 06e5ed1

Browse files
refactor : (multiple) major changes & fixes
1 parent a60b6cb commit 06e5ed1

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed

CONTRIBUTING.md

+25-5
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,37 @@
33
>This document is: OpenEBS Contributing Guidelines. OpenEBS is an umbrella project, composed as a federation of individual sub projects (repositories). This document applies to both the umbrella project and to every sub project in the OpenEBS organization.
44
<BR>
55
6-
There are many ways you can contribute to OpenEBS:
6+
There are many ways you can contribute to OpenEBS: <BR>
7+
```ruby
8+
Please use the following prioritized metholdology to submit contributions:
9+
```
10+
11+
| Priority | Type | Description |
12+
| :---: | :--- | :--- |
13+
| 1. | Global Slack | CNCF provides the **OpenEBS project** with a [```global Slack support Channel```](https://kubernetes.slack.com/messages/openebs/). All users and community members are welcome to engage all proejct memebrs via the Slack channel. |
14+
| 2. | [Org Discussions](https://github.com/orgs/openebs/discussions) | Our GitHub Discussions are enabled at the **Parent OpenEBS** ```Org level``` and aggregate all project/repo discussions into ONE Unified Umbrella scope for the best community discussion experince. Individual projects/repos ```Do Not``` have repos level GitHub discussions enabled. |
15+
| 3. | Repo Issues | Product Issues are managed for each ```individual repo```. You can create/submitt issues as per the normal GitHub methdology & rules. Please choose carefully if you are engaging the team in a [```General Discussion```](https://github.com/orgs/openebs/discussions) or need help with a very specifc **Product ```Issue```**. This will help you get the best community experince. Please create your interactions in the **correct** GitHub forum/tool. |
16+
| 4 | Repo Projects | We manage some major initiatives via the **GitHub Projects tool**. Users and community members are welcome to contribute, comment and participate in Public projects. Projects are enabled and managed on a per-repo basis. |
17+
| 5. | Repo PR's | You may engage and contribute via the standard **GitHub PR** ```(Pull Request)``` methodology. PR's are low-level repo/product/component focused engineering process used to manage **```low-level changes to code```**. For the best community experience, ```Do Not``` create PR's for **Discussions**, **Issues** or **support tickets**. (such items may be migrated to the appropriate forum/tool and could become stale and/or be closed without action/comment. |
18+
719
<BR>
820

9-
## Ask a question
10-
If you have questions about using OpenEBS, please use the OpenEBS Kubernetes slack channel, it is open for anyone to ask a question:
21+
## Ask a question :question:
22+
If you have questions about using OpenEBS, please use the CNCF Kubernetes **OpenEBS slack channel**, it is open for anyone to ask a question:
23+
<BR>
24+
> :arrow_forward: [OpenEBS Kubernetes Slack channel](https://kubernetes.slack.com/messages/openebs/)
1125
<BR>
12-
:arrow_forward: [OpenEBS Kubernetes Slack channel](https://kubernetes.slack.com/messages/openebs/)
1326
<BR>
1427
## Report a product issue
1528

16-
If you have a problem using OpenEBS, first check the [troubleshooting guide](https://openebs.io/docs/troubleshooting), you can also ask a question in the OpenEBS Kubernetes Slack channel.
29+
If you have a problem using OpenEBS, first check the [troubleshooting guide](https://openebs.io/docs/troubleshooting), you can also ask a question in the CNCF Kubernetes **OpenEBS slack channel**.
30+
31+
> [!NOTE]
32+
> - Our support and enginering team/community has a ```primary obligation``` to provide priority, focused spupprt for the **OpenEBS STANDARD** (OSS) [parent parnet](https://github.com/openebs) ```only```. <BR>
33+
> - Questions & issues relating to the Legacy Archived, Deprecated & Migrated OpenEBS projects, repos, code & dependancies are **not the focus** or responsibility of the parent OSS project; and may be provided on a ```best effort``` basis by the team. <BR>
34+
> - The overall open-source community is the main source of direct support for all **Legacy** ```Archived```, ```Deprecated``` & ```Migrated``` OpenEBS projects.
35+
> - please **```Do Not```** post Discussions, Issues or PR's on the **OpenEBS STANDARD** (OSS) [parent parnet](https://github.com/openebs).
36+
1737

1838
If you have an issue not solved by the troubleshooting guide or by asking a question in Slack, first check the GitHub issue list to see if the issue is already recorded, then add a New Issue.
1939

GOVERNANCE.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,10 @@ When a sub project is removed, it is moved as-is to the OpenEBS-archive organiza
115115

116116

117117
## How are decisions made?
118-
See CONTRIBUTORS.md
118+
[See CONTRIBUTING guidleines and rules doc](./CONTRIBUTING.md)
119+
```ruby
120+
Also see: MAINTAINERS file
121+
```
119122

120123
## Conflict Resolution
121124
If you have a technical dispute that you feel has reached an impasse with a subset of the community, any contributor may open an issue, specifically calling for a resolution vote of the current maintainers to resolve the dispute. The same voting quorums required (2/3) for removing maintainers will apply to conflict resolution.

0 commit comments

Comments
 (0)