mirror of
https://github.com/altstackHQ/altstack-data.git
synced 2026-04-17 22:53:13 +02:00
Add GitHub community standards, templates, and workflows
This commit is contained in:
10
.github/CODEOWNERS
vendored
Normal file
10
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
# Core Data Maintainers
|
||||
/data/ @aa-humaaan
|
||||
/data/schema @aa-humaaan
|
||||
|
||||
# Documentation Maintainers
|
||||
/docs/ @aa-humaaan
|
||||
|
||||
# Core Logic/Scripts
|
||||
/scripts/ @aa-humaaan
|
||||
|
||||
19
.github/ISSUE_TEMPLATE/add-guide.yml
vendored
Normal file
19
.github/ISSUE_TEMPLATE/add-guide.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
name: Add Deployment Guide
|
||||
description: Propose to add a new self-hosted deployment guide for an alternative tool.
|
||||
title: "[New Guide]: "
|
||||
labels: ["new-guide", "needs-review", "docs"]
|
||||
body:
|
||||
- type: input
|
||||
id: alternative_name
|
||||
attributes:
|
||||
label: Open Source Alternative Name
|
||||
description: What is the name of the OSS alternative?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: scope
|
||||
attributes:
|
||||
label: Guide Outline
|
||||
description: Briefly describe what the self-host guide will cover (e.g., Docker Compose, CapRover integration).
|
||||
validations:
|
||||
required: true
|
||||
40
.github/ISSUE_TEMPLATE/add-tool.yml
vendored
Normal file
40
.github/ISSUE_TEMPLATE/add-tool.yml
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
name: Add New Alternative Tool
|
||||
description: Propose a new open-source alternative to a popular SaaS product.
|
||||
title: "[New Tool]: "
|
||||
labels: ["add-tool", "needs-review"]
|
||||
body:
|
||||
- type: input
|
||||
id: proprietary_tool
|
||||
attributes:
|
||||
label: Proprietary Tool (Parent)
|
||||
description: What proprietary tool does this replace? (e.g., Slack, Notion)
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: alternative_name
|
||||
attributes:
|
||||
label: Open Source Alternative Name
|
||||
description: What is the name of the OSS alternative?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: website
|
||||
attributes:
|
||||
label: Website or GitHub URL
|
||||
description: Link to the alternative's main page.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: A brief paragraph describing what it does.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: pros_cons
|
||||
attributes:
|
||||
label: Pros and Cons
|
||||
description: List a few pros and cons for using this alternative.
|
||||
validations:
|
||||
required: true
|
||||
26
.github/ISSUE_TEMPLATE/fix-data.yml
vendored
Normal file
26
.github/ISSUE_TEMPLATE/fix-data.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
name: Fix Data Error
|
||||
description: Report a bug, broken link, or incorrect data point in the open-source dataset.
|
||||
title: "[Data Fix]: "
|
||||
labels: ["fix-data", "needs-review"]
|
||||
body:
|
||||
- type: input
|
||||
id: alternative_name
|
||||
attributes:
|
||||
label: Open Source Alternative Name
|
||||
description: What is the name of the OSS alternative that needs fixing?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: what_is_wrong
|
||||
attributes:
|
||||
label: What is Wrong?
|
||||
description: Please describe the incorrect data point (e.g., pricing link is a 404).
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: what_is_right
|
||||
attributes:
|
||||
label: Expected Fix
|
||||
description: What should the data be corrected to? Provide links to evidence if possible.
|
||||
validations:
|
||||
required: true
|
||||
14
.github/pull_request_template.md
vendored
Normal file
14
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
### What does this PR do?
|
||||
|
||||
Please provide a brief summary of the changes this PR introduces. E.g., adding a new Open Source alternative, fixing broken links, or adding a new deployment guide.
|
||||
|
||||
### Related Issues
|
||||
|
||||
Fixes #<ISSUE_NUMBER>
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] I've read the `CONTRIBUTING.md` guide.
|
||||
- [ ] If this adds a new tool, it includes the required schema fields, notably `id`, `name`, `type`, `url`, `open_source_url`.
|
||||
- [ ] If this updates docs, the changes are written in MDX to match existing docs in `docs/app/deploy/`.
|
||||
- [ ] This maintains a neutral, fact-based tone when making pros/cons edits.
|
||||
28
.github/workflows/check-docs.yml
vendored
Normal file
28
.github/workflows/check-docs.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
name: Docs Build Check
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- 'docs/**'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: docs
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: 'docs/package-lock.json'
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm ci || npm install
|
||||
|
||||
- name: Build Nextra Docs
|
||||
run: npm run build
|
||||
28
.github/workflows/validate-data.yml
vendored
Normal file
28
.github/workflows/validate-data.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
name: Validate JSON Data
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- 'data/**/*.json'
|
||||
pull_request:
|
||||
paths:
|
||||
- 'data/**/*.json'
|
||||
|
||||
jobs:
|
||||
validate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
- name: Check JSON Validity
|
||||
run: |
|
||||
for file in $(find data -name "*.json"); do
|
||||
echo "Validating $file..."
|
||||
jq empty "$file" || exit 1
|
||||
done
|
||||
echo "All JSON files are valid."
|
||||
Reference in New Issue
Block a user