Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Yangyang96 authored Dec 10, 2024
0 parents commit 8480eaa
Show file tree
Hide file tree
Showing 17 changed files with 542 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: "\U0001F41B Bug Report"
about: As a User, I want to report a Bug.
labels: type/bug
---

## Bug Report

Please answer these questions before submitting your issue. Thanks!

### 1. Minimal reproduce step (Required)

<!-- a step by step guide for reproducing the bug. -->

### 2. What did you expect to see? (Required)

### 3. What did you see instead (Required)

### 4. What is your KusionStack components version? (Required)

<!-- Paste the output of Kusion/kclvm-go/KCLVM version -->
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "\U0001F680 Enhancement"
about: As a KusionStack developer, I want to make an enhancement.
labels: type/enhancement
---

## Enhancement
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "\U0001F680 Feature Request"
about: As a user, I want to request a New Feature on the product.
labels: type/feature-request
---

## Feature Request

**Is your feature request related to a problem? Please describe:**
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Describe the feature you'd like:**
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered:**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Teachability, Documentation, Adoption, Migration Strategy:**
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. -->
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/general-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "\U0001F914 Ask a Question"
about: I want to ask a question.
labels: type/question
---

## General Question

<!--
Before asking a question, make sure you have:
- Googled your question.
- Searched open and closed
- Kusion: [GitHub issues](https://github.com/KusionStack/kusion/issues?utf8=%E2%9C%93&q=is%3Aissue)
- kclvm-go: [GitHub issues](https://github.com/KusionStack/kclvm-go/issues?utf8=%E2%9C%93&q=is%3Aissue)
- KCLVM: [GitHub issues](https://github.com/KusionStack/KCLVM/issues?utf8=%E2%9C%93&q=is%3Aissue)
- Read the documentation:
- [Doc](https://kusionstack.io/)
- [Kusion Readme](https://github.com/KusionStack/kusion)
- [kclvm-go Readme](https://github.com/KusionStack/kclvm-go)
- [KCLVM Readme](https://github.com/KusionStack/KCLVM)
-->
91 changes: 91 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!-- Thank you for contributing to KusionStack!
Note:
1. With pull requests:
- Open your pull request against "main"
- Your pull request should have no more than two commits, if not you should squash them.
- It should pass all tests in the available continuous integration systems such as GitHub Actions.
- You should add/modify tests to cover your proposed code changes.
- If your pull request contains a new feature, please document it on the README.
2. Please create an issue first to describe the problem.
We recommend that link the issue with the PR in the following question.
For more info, check https://kusionstack.io/docs/governance/contribute/
-->

#### 1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

- [ ] N
- [ ] Y

<!-- You can add issue references here.
e.g.
fix #123, re #123,
fix https://github.com/XXX/issues/44
-->

#### 2. What is the scope of this PR (e.g. component or file name):

<!-- You can add the scope of this change here.
e.g.
/src/server/core.rs,
kusionstack/KCLVM/kclvm-parser
-->

#### 3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

<!-- You can choose a brief description here -->
- [ ] Affects user behaviors
- [ ] Contains syntax changes
- [ ] Contains variable changes
- [ ] Contains experimental features
- [ ] Performance regression: Consumes more CPU
- [ ] Performance regression: Consumes more Memory
- [ ] Other

<!-- You can add more details here.
e.g.
Call method "XXXX" to ..... in order to ....,
More details: https://XXXX.com/doc......
-->

#### 4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

- [ ] N
- [ ] Y

<!-- You can add more details here.
e.g.
Calling method "XXXX" will cause the "XXXX", "XXXX" modules to be affected.
More details: https://XXXX.com/doc......
-->

#### 5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

<!-- You can choose a brief description here -->
- [ ] Unit test
- [ ] Integration test
- [ ] Benchmark (add benchmark stats below)
- [ ] Manual test (add detailed scripts or steps below)
- [ ] Other

<!-- You can add more details here.
e.g.
The test case in XXXX is used to .....
test cases in /src/tests/XXXXX
test cases https://github.com/XXX/pull/44
benchmark stats: time XXX ms
-->

#### 6. Release note

<!-- compatibility change, improvement, bugfix, and new feature need a release note -->

Please refer to [Release Notes Language Style Guide](https://kusionstack.io/docs/governance/release-policy/) to write a quality release note.

```release-note
None
```
8 changes: 8 additions & 0 deletions .github/README-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# KusionStack GitHub Template files

| File | Description |
|-|-|
| [`bug_report.md`](ISSUE_TEMPLATE/bug-report.md) | GitHub bug issue template. |
| [`enhancement-request.md`](ISSUE_TEMPLATE/enhancement.md) | GitHub enhancement issue template. |
| [`feature_request.md`](ISSUE_TEMPLATE/feature-request.md) | GitHub feature issue template. |
| [`general-question.md`](ISSUE_TEMPLATE/general-question.md) | General Question. |
40 changes: 40 additions & 0 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "CLA Assistant"
on:
issue_comment:
types: [created]
pull_request_target:
types: [opened,closed,synchronize]

jobs:
CLAssistant:
runs-on: ubuntu-latest
steps:
- name: "CLA Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
# Beta Release
uses: cla-assistant/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# the below token should have repo scope and must be manually added by you in the repository's secret
PERSONAL_ACCESS_TOKEN : ${{ secrets.KUSIONSTACK_BOT_TOKEN }}
with:
path-to-document: 'https://github.com/KusionStack/.github/blob/main/CLA.md' # e.g. a CLA or a DCO document

# branch should not be protected
lock-pullrequest-aftermerge: True
path-to-signatures: 'signatures/version1/cla.json'
remote-organization-name: KusionStack
remote-repository-name: cla.db
branch: 'main'
allowlist: 'test'

#below are the optional inputs - If the optional inputs are not given, then default values will be taken
#remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
#remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
#create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
#signed-commit-message: 'For example: $contributorName has signed the CLA in #$pullRequestNo'
#custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
#use-dco-flag: true - If you are using DCO instead of CLA
30 changes: 30 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# KusionStack Contributor License Agreement (CLA)

Thank you for your interest in contributing to KusionStack! In order to facilitate collaboration and ensure the proper use of contributions, we require all contributors to sign a Contributor License Agreement (CLA).

KusionStack is a [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/) Sandbox Project and therefore leverages CNCF CLAs. Below you'll find links to both the individual CLA and the corporate CLA defined by the CNCF.

### Individual Contributor License Agreement (ICLA)

If you are contributing to this project as an individual, please review and sign the [Individual Contributor License Agreement (ICLA)](https://github.com/cncf/cla/blob/main/individual-cla.pdf).

### Corporate Contributor License Agreement (CCLA)

If you are contributing on behalf of an organization, please review and sign the [Corporate Contributor License Agreement (CCLA)](https://github.com/cncf/cla/blob/main/corporate-cla.pdf).

## Signing the CLA

You can sign the CLA by posting a Pull Request Comment in the below format:
```
I have read the CLA Document and I hereby sign the CLA
```

## Contact Information

If you have any questions regarding this CLA or the contribution process, please don’t hesitate to reach out to us at [[email protected]](mailto:[email protected]).

Thank you for your contributions and support in making KusionStack better!

---

By contributing to this project, you acknowledge that you have read and agree to abide by the terms of the Contributor License Agreements.
2 changes: 2 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Order in this file is important. Only the last match will be
# used. See https://help.github.com/articles/about-code-owners/
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# KusionStack Community Code of Conduct

KusionStack follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributing

## This repo is part of [KusionStack](https://kusionstack.io)

For details on how to contribute to the KusionStack project, please see the main [contributing document](https://github.com/KusionStack/community/blob/master/CONTRIBUTING.md).
Loading

0 comments on commit 8480eaa

Please sign in to comment.