Skip to content

Commit

Permalink
add resource
Browse files Browse the repository at this point in the history
  • Loading branch information
orangekame3 committed Sep 3, 2024
1 parent 7d12737 commit 6bf7b5d
Show file tree
Hide file tree
Showing 263 changed files with 24,919 additions and 2 deletions.
26 changes: 26 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true


[*.{js,json}]
indent_size = 2

[*.{tf,tftfvars}]
indent_size = 2
indent_style = space

[*.md]
max_line_length = 0
trim_trailing_whitespace = false

[{Makefile,**.mk}]
indent_style = tab
[*.py]
indent_size = 4
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @orangekame3 @shgokita
77 changes: 77 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to creating a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [oqtopus-team[at]googlegroups.com](mailto:oqtopus-team[at]googlegroups.com). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression towards or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
29 changes: 29 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# How to Contribute

Thank you for your interest in our project. This project is built by the community. Please refer to the following guidelines on how to contribute to the project.

## Code of Conduct

This project adopts a [Code of Conduct](./CODE_OF_CONDUCT.md). Please adhere to this Code of Conduct when participating, contributing, and communicating in the project.

## Reporting Bugs

If you find a bug, please create an issue following the [Bug Report Template](https://github.com/oqtopus-team/oqtopus-cloud/tree/develop/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml).

## Questions

If you have any questions, please create an issue following the [Question Template](https://github.com/oqtopus-team/oqtopus-cloud/tree/develop/.github/ISSUE_TEMPLATE/QUESTION.yaml).

## Feature Requests

If you have a new feature request, please create an issue following the [Feature Request Template](https://github.com/oqtopus-team/oqtopus-cloud/tree/develop/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yaml).

## Coding Guidelines

For developer information, please refer to the [Developer Information](https://oqtopus-team.github.io/oqtopus-cloud). Check the coding guidelines.

## Commit Message Guidelines

For how to write commit messages, please refer to the [Developer Information](https://oqtopus-team.github.io/oqtopus-cloud).

Thank you for your contributions!
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: Create a report to help us improve
title: "[Bug]: "
labels: [bug]
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug. Please provide a clear and concise description of the problem and steps to reproduce it.
- type: input
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.

- type: textarea
id: steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: input
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.

- type: dropdown
id: environment
attributes:
label: Environment
description: Please select your environment.
options:
- label: Windows
value: windows
- label: Mac
value: mac
- label: Linux
value: linux

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation request
description: Request for documentation improvements or additions
title: "[Docs]: "
labels: [documentation]
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for requesting documentation improvements or additions. Please provide a clear and concise description of what you want to be added or improved.
- type: input
id: description
attributes:
label: Describe the documentation request
description: A clear and concise description of what you want to be added or improved.

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the documentation request here.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature Request]: "
labels: [enhancement]
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature. Please provide a clear and concise description of the feature and its use case.
- type: input
id: description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Question
description: Ask a question about the project
title: "[Question]: "
labels: [question]
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for taking the time to ask a question. Please provide a clear and concise question along with any relevant context or additional information that might help in answering your question.
- type: input
id: question
attributes:
label: What is your question?
description: Please provide a clear and concise question.

- type: textarea
id: context
attributes:
label: Context or additional information
description: Provide any relevant context or additional information.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/TASK.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Task
description: Track a task that needs to be completed
title: "[Task]: "
labels: [enhancement]
assignees: []

body:
- type: markdown
attributes:
value: |
Thank you for creating a task. Please provide a clear and concise description of the task and any relevant details.
- type: input
id: task_description
attributes:
label: Task Description
description: A clear and concise description of what the task is.

- type: textarea
id: steps
attributes:
label: Steps
description: Steps to complete the task.
value: |
1. Step one
2. Step two
3. Step three
- type: input
id: due_date
attributes:
label: Due Date
description: The date by which this task should be completed.
placeholder: "YYYY-MM-DD"

- type: dropdown
id: priority
attributes:
label: Priority
description: Please select the priority level for this task.
options:
- label: Low
value: low
- label: Medium
value: medium
- label: High
value: high

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or details about the task here.
12 changes: 12 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Security Policy

## Reporting Vulnerabilities

If you discover a vulnerability, please follow the steps below to report it.

1. **Report via Email**: Send the details of the vulnerability to [oqtopus-team[at]googlegroups.com](mailto:oqtopus-team[at]googlegroups.com). Please include the following information in your report:
- A detailed description of the vulnerability
- Steps to reproduce the vulnerability
- The impact range of the vulnerability
- Your name (optional)
- Contact information (optional)
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 📃 Ticket
<!--- Paste related ticket -->

## ✍ Description
<!--- Describe your changes in detail -->

## 📸 Test Result
<!--- Paste `make test result` -->

## 🔗 Related PRs
<!--- Paste related PRs -->
Loading

0 comments on commit 6bf7b5d

Please sign in to comment.