-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Xinwei Xiong(cubxxw) <[email protected]>
- Loading branch information
Showing
16 changed files
with
663 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
Read the [contributor guide](../CONTRIBUTING.md) for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
github: [cubxxw] | ||
liberapay: "xiongxinwei/donate" | ||
paypal: ["paypal.me/cubxxw", paypal.me] | ||
custom: ["https://www.paypal.me/cubxxw", nsddd.top] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
--- | ||
name: RFC | ||
about: The OpenIM RFC design template, which you should use if you have a detailed and precise feature design in mind. | ||
title: "🔮[RFC #0000]: " | ||
labels: "proposal,RFC,kind/feature,enhancement" | ||
|
||
--- | ||
|
||
# [RFC #0000] OpenIMSDK proposal template | ||
<!-- | ||
🤖 design template: https://github.com/OpenIMSDK/community/blob/main/0000-template.md | ||
⚠️ Please submit a PR to https://github.com/OpenIMSDK/community/tree/main/RFC according to the specification after the design is completed | ||
--> | ||
## Meta | ||
[meta]: #meta | ||
- Name: (fill in the feature name: My Feature) | ||
- Start Date: (fill in today's date: YYYY-MM-DD) | ||
- Author(s): (Github usernames) | ||
- Status: Draft <!-- Acceptable values: Draft, Approved, On Hold, Superseded --> | ||
- RFC Pull Request: (leave blank) | ||
- OpenIMSDK Pull Request: (leave blank) | ||
- OpenIMSDK Issue: (leave blank) | ||
- Supersedes: (put "N/A" unless this replaces an existing RFC, then link to that RFC) | ||
|
||
|
||
## 📇Topics | ||
- [\[RFC #0000\] OpenIMSDK proposal template](#rfc-0000-openimsdk-proposal-template) | ||
- [Meta](#meta) | ||
- [📇Topics](#topics) | ||
- [Summary](#summary) | ||
- [Definitions](#definitions) | ||
- [Motivation](#motivation) | ||
- [What it is](#what-it-is) | ||
- [How it Works](#how-it-works) | ||
- [Migration](#migration) | ||
- [Drawbacks](#drawbacks) | ||
- [Alternatives](#alternatives) | ||
- [Prior Art](#prior-art) | ||
- [Unresolved Questions](#unresolved-questions) | ||
- [Spec. Changes (OPTIONAL)](#spec-changes-optional) | ||
- [History](#history) | ||
|
||
|
||
## Summary | ||
[summary]: #summary | ||
|
||
One paragraph explanation of the feature. | ||
|
||
## Definitions | ||
[definitions]: #definitions | ||
|
||
Make a list of the definitions that may be useful for those reviewing. Include phrases and words that OpenIMSDK authors or other interested parties may not be familiar with. | ||
|
||
## Motivation | ||
[motivation]: #motivation | ||
|
||
- Why should we do this? | ||
- What use cases does it support? | ||
- What is the expected outcome? | ||
|
||
## What it is | ||
[what-it-is]: #what-it-is | ||
|
||
This provides a high level overview of the feature. | ||
|
||
- Define any new terminology. | ||
- Define the target persona: OpenIMSDK author, OpenIMSDK user, platform operator, platform implementor, and/or project contributor. | ||
- Explaining the feature largely in terms of examples. | ||
- If applicable, provide sample error messages, deprecation warnings, or migration guidance. | ||
- If applicable, describe the differences between teaching this to existing users and new users. | ||
|
||
## How it Works | ||
[how-it-works]: #how-it-works | ||
|
||
This is the technical portion of the RFC, where you explain the design in sufficient detail. | ||
|
||
The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work. | ||
|
||
## Migration | ||
[migration]: #migration | ||
|
||
This section should document breaks to public API and breaks in compatibility due to this RFC's proposed changes. In addition, it should document the proposed steps that one would need to take to work through these changes. Care should be give to include all applicable personas, such as platform developers, OpenIMSDK developers, OpenIMSDK users and consumers of OpenIMSDK images. | ||
|
||
## Drawbacks | ||
[drawbacks]: #drawbacks | ||
|
||
Why should we *not* do this? | ||
|
||
## Alternatives | ||
[alternatives]: #alternatives | ||
|
||
- What other designs have been considered? | ||
- Why is this proposal the best? | ||
- What is the impact of not doing this? | ||
|
||
## Prior Art | ||
[prior-art]: #prior-art | ||
|
||
Discuss prior art, both the good and bad. | ||
|
||
## Unresolved Questions | ||
[unresolved-questions]: #unresolved-questions | ||
|
||
- What parts of the design do you expect to be resolved before this gets merged? | ||
- What parts of the design do you expect to be resolved through implementation of the feature? | ||
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC? | ||
|
||
## Spec. Changes (OPTIONAL) | ||
[spec-changes]: #spec-changes | ||
Does this RFC entail any proposed changes to the core specifications or extensions? If so, please document changes here. | ||
Examples of a spec. change might be new lifecycle flags, new `OpenIMSDK.toml` fields, new fields in the OpenIMSDKage label, etc. | ||
This section is not intended to be binding, but as discussion of an RFC unfolds, if spec changes are necessary, they should be documented here. | ||
|
||
## History | ||
[history]: #history | ||
|
||
<!-- | ||
## Amended | ||
### Meta | ||
[meta-1]: #meta-1 | ||
- Name: (fill in the amendment name: Variable Rename) | ||
- Start Date: (fill in today's date: YYYY-MM-DD) | ||
- Author(s): (Github usernames) | ||
- Amendment Pull Request: (leave blank) | ||
### Summary | ||
A brief description of the changes. | ||
### Motivation | ||
Why was this amendment necessary? | ||
---> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
name: Bug Report | ||
description: Report a bug encountered while operating OpenIM | ||
title: "Bug: " | ||
labels: ["kind/bug"] | ||
body: | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: What happened? | ||
description: | | ||
Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: What did you expect to happen? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: repro | ||
attributes: | ||
label: How can we reproduce it (as minimally and precisely as possible)? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: additional | ||
attributes: | ||
label: Anything else we need to know? | ||
|
||
- type: textarea | ||
id: Version | ||
attributes: | ||
label: version | ||
value: | | ||
<details> | ||
```console | ||
$ {name} version | ||
# paste output here | ||
``` | ||
</details> | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: cloudProvider | ||
attributes: | ||
label: Cloud provider | ||
value: | | ||
<details> | ||
</details> | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: osVersion | ||
attributes: | ||
label: OS version | ||
value: | | ||
<details> | ||
```console | ||
# On Linux: | ||
$ cat /etc/os-release | ||
# paste output here | ||
$ uname -a | ||
# paste output here | ||
# On Windows: | ||
C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture | ||
# paste output here | ||
``` | ||
</details> | ||
- type: textarea | ||
id: installer | ||
attributes: | ||
label: Install tools | ||
value: | | ||
<details> | ||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
contact_links: | ||
- name: Connect on slack | ||
url: https://join.slack.com/t/c-ub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ | ||
about: Support OpenIM-related requests or issues, get in touch with developers and help on slack | ||
contact_links: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Failing Test | ||
description: Report continuously failing tests or jobs in OpenIM CI | ||
title: "🤖Failing test: " | ||
labels: kind/failing-test | ||
body: | ||
- type: textarea | ||
id: jobs | ||
attributes: | ||
label: Which job are failing? | ||
placeholder: | | ||
Please only use this template for submitting reports about continuously failing tests or jobs in OpenIM CI. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: tests | ||
attributes: | ||
label: Which test are failing? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: since | ||
attributes: | ||
label: Since when has it been failing? | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: testgrid | ||
attributes: | ||
label: Testgrid link | ||
|
||
- type: textarea | ||
id: reason | ||
attributes: | ||
label: Reason for failure (if possible) | ||
|
||
- type: textarea | ||
id: additional | ||
attributes: | ||
label: Anything else we need to know? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Feature Request | ||
description: Suggest and idea for this project | ||
title: "[Feature]: <Feature Request Title>" | ||
labels: ["type:feature"] | ||
assignees: | ||
- kubecub/maintainers | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for initiating this feature request !🤗 | ||
- type: checkboxes | ||
id: checklist | ||
attributes: | ||
label: Checklist | ||
description: "Please check the following before submitting this feature request" | ||
options: | ||
- label: I've searched for similar issues and couldn't find anything matching | ||
required: true | ||
- label: I've discussed this feature request in the [kubecub Slack](https://join.slack.com/t/c-ub/shared_invite/zt-1se0k2bae-lkYzz0_T~BYh3rjkvlcUqQ) and got positive feedback | ||
required: true | ||
|
||
- type: dropdown | ||
id: problem | ||
attributes: | ||
label: Is this feature request related to a problem? | ||
options: | ||
- "Yes" | ||
- "No" | ||
- type: textarea | ||
id: problem_description | ||
attributes: | ||
label: Problem Description | ||
description: If yes, please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: solution_description | ||
attributes: | ||
label: Solution Description | ||
description: A clear and concise description of what you want to happen | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: benefits_description | ||
attributes: | ||
label: Benefits | ||
description: Describe the benefits this feature will bring to the project and its users | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: drawbacks | ||
attributes: | ||
label: Potential Drawbacks | ||
description: Describe any potential drawbacks this feature might bring to the project and its users. | ||
- type: textarea | ||
id: additional_information | ||
attributes: | ||
label: Additional Information | ||
description: Add any other context about your feature request here. If applicable, add drawings to help explain. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
reviewers: | ||
- cubxxw | ||
approvers: | ||
- cubxxw |
Oops, something went wrong.