Skip to content

Commit

Permalink
finish github setup
Browse files Browse the repository at this point in the history
  • Loading branch information
Lulalaby committed Dec 17, 2024
1 parent fa5e538 commit e1f0434
Show file tree
Hide file tree
Showing 13 changed files with 562 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Aiko-IT-Systems/aitsys @Lulalaby
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Bug Report
description: Report broken or incorrect behaviour
labels: ["unconfirmed bug"]
body:
- type: markdown
attributes:
value: >
Thanks for taking the time to fill out a bug. If you want real-time support,
consider joining our Discord at DISCORD_INVITE instead.
Please note that this form is for bugs only!
- type: input
attributes:
label: Summary
description: A simple summary of your bug report
validations:
required: true
- type: textarea
attributes:
label: Reproduction Steps
description: >
What you did to make it happen.
validations:
required: true
- type: textarea
attributes:
label: Minimal Reproducible Code
description: >
A short snippet of code that showcases the bug.
render: python
- type: textarea
attributes:
label: Expected Results
description: >
What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: >
What actually happened?
validations:
required: true
- type: textarea
attributes:
label: System Information
description: >
Send us all the information you can about your system.
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
description: >
Let's make sure you've properly done due diligence when reporting this issue!
options:
- label: I have searched the open issues for duplicates.
required: true
- label: I have shown the entire traceback, if possible.
required: true
- label: I have removed my token from display, if visible.
required: true
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Server
about: Use our official Discord server to ask for help
url: https://discord.gg/Uk7sggRBTm
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature Request
description: Suggest a feature for this library
labels: ["feature request"]
body:
- type: input
attributes:
label: Summary
description: >
A short summary of what your feature request is.
validations:
required: true
- type: textarea
attributes:
label: The Problem
description: >
What problem is your feature trying to solve? What becomes easier or possible
when this feature is implemented?
validations:
required: true
- type: textarea
attributes:
label: The Ideal Solution
description: >
What is your ideal solution to the problem? What would you like this feature to
do?
validations:
required: true
- type: textarea
attributes:
label: The Current Solution
description: >
What is the current solution to the problem, if any?
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.
23 changes: 23 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Security Policy

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| > 1.0 | :white_check_mark: |

## Reporting a Vulnerability

If you discover a security vulnerability, we would like to know about it so we can take steps to address it as quickly as possible. Please report any security vulnerabilities to us by writing an email to [[email protected]](mailto:[email protected]) or by opening a ticket in our Discord server.

## Responsible Disclosure

We believe in responsible disclosure. Please give us adequate time to investigate and mitigate an issue before publicly disclosing any security vulnerabilities. This helps protect our users and ensure the issue is properly addressed.

## Enforcement

We take security seriously at DisCatSharp. Attempts to flood or overload our systems, or any other form of attack, will not be tolerated and will be met with strict enforcement actions, including potential bans.

## Acknowledgment

By contributing to this project, you agree to abide by this Security Policy and understand that violations may result in enforcement actions, including bans or removal from the community.
23 changes: 23 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
version: "1"
labels:
- label: "ci/cd"
files:
- ".github/.*"
- ".github/workflows/.*"
- label: "branding"
files:
- ".*.jpg"
- ".*.png"
- ".*.svg"
- ".*.jpeg"
- ".*.gif"
- ".*.css"
- label: "documentation"
files:
- "AITSYS.Vimeo.Ott.Docs/.*"
- label: "experimental"
title: ^[Exp]:.*
- label: "dependencies"
files:
- ".*.csproj"
- ".*.sln"
40 changes: 40 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 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.

<!-- If this relates to an aitsys.dev issue:
Fixes {TXXX} (aitsys.dev issue)
-->

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# 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 A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules

@Aiko-IT-Systems/aitsys
64 changes: 64 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: "Build Library"

on:
push:
branches:
- main
paths-ignore:
- "AITSYS.Vimeo.Ott.Docs/**"
- "*.md"
- "*.json"
pull_request:
merge_group:
workflow_dispatch:

env:
DOTNET_NOLOGO: true
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
DOTNET_CLI_TELEMETRY_OPTOUT: true
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: true

jobs:
build:
timeout-minutes: 15
strategy:
matrix:
os: [ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
name: Build library
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup .NET
uses: actions/[email protected]
with:
dotnet-version: 9.x
- name: Restore dependencies
run: dotnet restore --no-cache -f -v AITSYS.Vimeo.Ott.sln
- name: Build library
run: dotnet build -c Release -v minimal --no-restore AITSYS.Vimeo.Ott.sln
- name: Test library
run: dotnet test -v minimal -c Release --no-restore --no-build AITSYS.Vimeo.Ott.sln
pack:
timeout-minutes: 15
runs-on: ubuntu-latest
name: "Pack and Artifact"
needs: build
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup .NET
uses: actions/[email protected]
with:
dotnet-version: 9.x
- name: Restore Packages
run: dotnet restore --no-cache -f -v minimal AITSYS.Vimeo.Ott.sln
- name: Build library
run: dotnet build -c Release -v minimal --no-restore AITSYS.Vimeo.Ott.sln
- name: Publish library
run: dotnet pack -c Release -v minimal --no-build --no-restore --include-symbols --include-source -o ./artifacts AITSYS.Vimeo.Ott.sln
- name: Upload artifacts
uses: actions/[email protected]
with:
name: AITSYS.Vimeo.Ott
path: ./artifacts/
47 changes: 47 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "CodeQL"

on:
push:
branches:
- main
paths-ignore:
- "AITSYS.Vimeo.Ott.Docs/**"
- "*.md"
- "*.json"
pull_request:
branches:
- main
schedule:
- cron: "39 18 * * 3"
merge_group:
workflow_dispatch:

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: ["csharp"]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
- name: Set up dotnet
uses: actions/setup-dotnet@v4
with:
dotnet-version: 9.x
- name: Restore dependencies
run: dotnet restore --no-cache -f -v minimal AITSYS.Vimeo.Ott.sln
- name: Build
run: dotnet build -c Release -v minimal --no-restore --no-self-contained AITSYS.Vimeo.Ott.sln
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
15 changes: 15 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "Label PRs"

on:
pull_request_target:
types:
- opened

jobs:
label:
runs-on: ubuntu-latest
name: Label PRs
steps:
- uses: srvaroa/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.NYUW_TOKEN_GH }}"
27 changes: 27 additions & 0 deletions ARTICLES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Writing articles for AITSYS.Vimeo.Ott

## Markdown header

```md
---
uid: article_name
title: Article Title
description: Short article description
author: AITSYS Team
---

Your article content
```

## Available yml header options

| Key | Description | Example |
| ----------- | ------------------ | ----------- |
| uid | uid for cross ref | cats |
| title | site title | Cats |
| description | short summarize | Meow |
| author | your name | AITSYS Team |

## Markdown docs for docfx

https://dotnet.github.io/docfx/docs/markdown.html
Loading

0 comments on commit e1f0434

Please sign in to comment.