Skip to content

Commit

Permalink
doc(): all oss component added
Browse files Browse the repository at this point in the history
Signed-off-by: Md Imran <[email protected]>
  • Loading branch information
narmidm committed Nov 27, 2023
1 parent 5378436 commit cb94733
Show file tree
Hide file tree
Showing 11 changed files with 564 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: "🐛 Bug Report"
description: "Submit a bug report to help us improve"
title: "Bug: "
labels: [bug]
assignees: ["narmidm","bharath-avesha","Rahul-D78","gourishkb","mridulgain","richiesebastian"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out our bug report form 🙏
- type: textarea
id: description
validations:
required: true
attributes:
label: "📜 Description"
description: "A clear and concise description of what the bug is."
placeholder: "It bugs out when ..."
- type: textarea
id: steps-to-reproduce
validations:
required: true
attributes:
label: "👟 Reproduction steps"
description: "How do you trigger this bug? Please walk us through it step by step."
placeholder: "1. When I ..."
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: "👍 Expected behavior"
description: "What did you think would happen?"
placeholder: "It should ..."
- type: textarea
id: actual-behavior
validations:
required: true
attributes:
label: "👎 Actual Behavior"
description: "What did actually happen? Add screenshots, if applicable."
placeholder: "It actually ..."
- type: textarea
id: logs
attributes:
label: "🐚 Relevant log output"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: version
attributes:
label: Version
description: What version of our software are you running?
placeholder: "I used ...."
- type: dropdown
id: os
attributes:
label: "🖥️ What operating system are you seeing the problem on?"
multiple: true
options:
- Linux
- MacOS
- Windows
- type: textarea
id: solution
validations:
required: false
attributes:
label: "✅ Proposed Solution"
description: "Any thoughts as to potential solutions or ideas to go about finding one. Please include links to any research."
placeholder: "To fix this, I found ..."
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you spent some time to check if this issue has been raised before?"
description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
options:
- label: "I checked and didn't find any similar issue"
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: I have read the [https://github.com/kubeslice/gateway-certs-generator/blob/master/code_of_conduct.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 🚀 Feature
description: "Submit a proposal for a new feature"
title: "Feature: "
labels: [feature]
assignees: ["narmidm","bharath-avesha","Rahul-D78","gourishkb","mridulgain","richiesebastian"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out our feature request form 🙏
- type: textarea
id: feature-description
validations:
required: true
attributes:
label: "🔖 Feature description"
description: "A clear and concise description of what the feature is."
placeholder: "You should add ..."
- type: textarea
id: pitch
validations:
required: true
attributes:
label: "🎤 Pitch"
description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable."
placeholder: "In my use-case, ..."
- type: textarea
id: solution
validations:
required: true
attributes:
label: "✌️ Solution"
description: "A clear and concise description of what you want to happen."
placeholder: "I want this feature to, ..."
- type: textarea
id: alternative
validations:
required: false
attributes:
label: "🔄️ Alternative"
description: "A clear and concise description of any alternative solutions or features you've considered."
placeholder: "I tried, ..."
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you spent some time to check if this issue has been raised before?"
description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
options:
- label: "I checked and didn't find similar issue"
required: true
- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Code of Conduct?"
options:
- label: "I have read the [Code of Conduct](https://github.com/kubeslice/gateway-certs-generator/blob/master/code_of_conduct.md)"
required: true
49 changes: 49 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!--
Type of change: Title of the PR should clearly mention which type of PR is this, you can select any of the below mentioned types:
- docs() - The PR contains Documentation ONLY changes.
- feat() - The PR contains new feature/enhancements.
- fix() - The PR contains a bug fix.
- chore() - Development changes related to the build system (involving scripts, configurations or tools) and package dependencies.
- test() - Development changes related to tests.
- perf() - Changes related to performance improvements.
Example Title:
feat(): New field addition for Cluster CRD
-->

# Description
<!--
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
-->

Fixes #

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
<!--test-cases
- [ ] Test case A
- [ ] Test case B
-->

## Checklist:

* [ ] The title of the PR states what changed and the related issues number (used for the release note).
* [ ] Does this PR requires documentation updates?
* [ ] I've updated documentation as required by this PR.
* [ ] I have performed a self-review of my own code.
* [ ] I have commented my code, particularly in hard-to-understand areas.
* [ ] I have tested it for all user roles.
* [ ] I have added all the required unit test cases.

## Does this PR introduce a breaking change for other components like kubeslice-controller, worker-operator?
<!--
If NO, leave the release-note block blank.
If YES, a release note is required:
Enter your extended release note in the block below. If the PR requires additional manual action from users switching to the new version, include the string "action-required".
-->
```release-note
```

18 changes: 18 additions & 0 deletions .github/workflows/docker-build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: build-image
on:
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: checkout the repo
uses: actions/checkout@v2
- name: build the docker image
uses: docker/build-push-action@v2
with:
context: .
file: ./Dockerfile
tags: aveshadev/slicegw-edge:latest
push: false
- name: List images
run: docker image ls
37 changes: 37 additions & 0 deletions .github/workflows/trivy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: trivy
on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '29 19 * * 6'
permissions:
contents: read

jobs:
build:
permissions:
contents: read # for actions/checkout to fetch code
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
name: Build
runs-on: ubuntu-20.04
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Run Trivy vulnerability scanner in repo mode
uses: aquasecurity/trivy-action@master
with:
scan-type: 'repo'
ignore-unfixed: true
format: 'sarif'
output: 'trivy-results.sarif'
severity: 'CRITICAL'

- name: Upload Trivy scan results to GitHub Security tab
uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: 'trivy-results.sarif'
13 changes: 13 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Names should be added to this file as
# Name or Organization <email address>
# The email address is not required for organizations.

# You can update this list using the following command:
#
# $ (head -n10 AUTHORS && git shortlog -se | sed -E 's/^\s+[0-9]+\t//') | tee AUTHORS

# Please keep the list sorted.
MD IMRAN <[email protected]>
Bharath Horatti <[email protected]>
Md Imran <[email protected]>
bharath-avesha <[email protected]>
67 changes: 67 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
#* @global-owner1 @global-owner2

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
#*.js @js-owner #This is an inline comment.

# You can also use email addresses if you prefer. They'll be
# used to look up users just like we do for commit author
# emails.
#*.go [email protected]

# Teams can be specified as code owners as well. Teams should
# be identified in the format @org/team-name. Teams must have
# explicit write access to the repository. In this example,
# the octocats team in the octo-org organization owns all .txt files.
#*.txt @octo-org/octocats

# In this example, @doctocat owns any files in the build/logs
# directory at the root of the repository and any of its
# subdirectories.
#/build/logs/ @doctocat

# The `docs/*` pattern will match files like
# `docs/getting-started.md` but not further nested files like
# `docs/build-app/troubleshooting.md`.
#docs/* [email protected]

# In this example, @octocat owns any file in an apps directory
# anywhere in your repository.
#apps/ @octocat

# In this example, @doctocat owns any file in the `/docs`
# directory in the root of your repository and any of its
# subdirectories.
#/docs/ @doctocat

# In this example, any change inside the `/scripts` directory
# will require approval from @doctocat or @octocat.
#/scripts/ @doctocat @octocat

# In this example, @octocat owns any file in a `/logs` directory such as
# `/build/logs`, `/scripts/logs`, and `/deeply/nested/logs`. Any changes
# in a `/logs` directory will require approval from @octocat.
#**/logs @octocat

# In this example, @octocat owns any file in the `/apps`
# directory in the root of your repository except for the `/apps/github`
# subdirectory, as its owners are left empty.
#/apps/ @octocat
#/apps/github

# In this example, @octocat owns any file in the `/apps`
# directory in the root of your repository except for the `/apps/github`
# subdirectory, as this subdirectory has its own owner @doctocat
#/apps/ @octocat
#/apps/github @doctocat

* @narmidm @bharath-avesha @Rahul-D78 @gourishkb @mridulgain
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contributing

Guidelines on how to contribute to KubeSlice

There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the [Code of Conduct](https://github.com/kubeslice/gateway-certs-generator/blob/master/code_of_conduct.md).


Here are some ways to contribute:

* Contribute to the KubeSlice codebase.
* Report and triage bugs.
* Answer questions on KubeSlice discussions forums.
* Write technical documentation and blog posts, for users and contributors.
* File Issues.
* Provide feedback on the codebase and documentation.
* Submit PRs for small bug fixes.

## Contributor Compliance with Developer Certificate Of Origin (DCO)

We require every contributor to certify that they are legally permitted to contribute to our project. A contributor expresses this by consciously signing their commits, and by this act expressing that they comply with the Developer Certificate Of Origin

A signed commit is a commit where the commit message contains the following content:

`Signed-off-by: John Doe <[email protected]>`

This can be done by adding `--signoff` to your git command line

## Code of Conduct
Please make sure to read and observe our [Code of Conduct](https://github.com/kubeslice/gateway-certs-generator/blob/master/code_of_conduct.md).

## Contributor Workflow

Pull Requests are welcome. In general, we follow the "fork-and-pull" Git workflow that has the following steps:

1. **Fork** the repo on GitHub.
2. **Clone** the project to your own machine.
3. **Commit** changes to your own branch.
4. **Push** your work back up to your fork.
5. Submit a **Pull request** so that we can review your changes.

NOTE: Be sure to merge the latest from **upstream** before making a pull request!

## Filing Issues
If you encounter a bug, please file an issue in the Github repository. Please provide as much information as possible to help fix the issue. Please file the issue under the appropriate repo.


## Coding Guidelines
* Follow good [coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
* Write good [commit messages](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).

## License
Apache License 2.0
8 changes: 8 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# KubeSlice slicegw-edge Maintainers
The maintainers are generally available in Slack at https://kubernetes.slack.com in channel #kubeslice

Md Imran [email protected]
Eric Peterson [email protected]
Prabhu Navali [email protected]
Bharath Horatti [email protected]
Richie Sebastian [email protected]
Loading

0 comments on commit cb94733

Please sign in to comment.