Skip to content

Commit c318220

Browse files
h4x3rotabclaude
h4x3rotab
and
claude
committed
feat: make repository professional and developer-friendly
- Enhanced README with badges and clear structure - Added CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md - Created GitHub issue/PR templates and CI workflows - Replaced Makefile with simple dev.sh script - Updated to Apache 2.0 license - Added example templates for consistency Co-Authored-By: Claude <noreply@anthropic.com>
1 parent af88222 commit c318220

15 files changed

Lines changed: 1994 additions & 43 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Bug Report
2+
description: Report a bug in one of the examples
3+
title: "[BUG] "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
10+
11+
- type: dropdown
12+
id: example
13+
attributes:
14+
label: Example Name
15+
description: Which example is experiencing the issue?
16+
options:
17+
- attestation/configid-based
18+
- attestation/rtmr3-based
19+
- custom-domain
20+
- launcher
21+
- lightclient
22+
- phala-cloud-prelaunch-script
23+
- prelaunch-script
24+
- private-docker-image-deployment
25+
- ssh-over-gateway
26+
- tcp-port-forwarding
27+
- timelock-nts
28+
- tor-hidden-service
29+
- webshell
30+
- Other (specify in description)
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: description
36+
attributes:
37+
label: Bug Description
38+
description: A clear and concise description of what the bug is.
39+
placeholder: Describe the bug...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reproduction
45+
attributes:
46+
label: Steps to Reproduce
47+
description: Steps to reproduce the behavior
48+
placeholder: |
49+
1. Deploy example with `docker compose up -d`
50+
2. Run command `...`
51+
3. See error
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: expected
57+
attributes:
58+
label: Expected Behavior
59+
description: A clear description of what you expected to happen
60+
placeholder: What should have happened?
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: actual
66+
attributes:
67+
label: Actual Behavior
68+
description: What actually happened?
69+
placeholder: What actually happened?
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: environment
75+
attributes:
76+
label: Environment
77+
description: Please provide information about your environment
78+
value: |
79+
- OS: [e.g. Ubuntu 22.04, macOS 13.0]
80+
- Docker version: [e.g. 24.0.0]
81+
- Docker Compose version: [e.g. v2.20.0]
82+
- Dstack version: [e.g. v0.5.1]
83+
render: markdown
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
id: logs
89+
attributes:
90+
label: Logs
91+
description: Please paste any relevant logs or error messages
92+
placeholder: Paste logs here...
93+
render: shell
94+
95+
- type: textarea
96+
id: additional
97+
attributes:
98+
label: Additional Context
99+
description: Add any other context about the problem here
100+
placeholder: Any additional information...
101+
102+
- type: checkboxes
103+
id: security
104+
attributes:
105+
label: Security Impact
106+
description: Does this bug have security implications?
107+
options:
108+
- label: This bug has security implications (please also email dstack@phala.network)
109+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Community Discussion
4+
url: https://t.me/+UO4bS4jflr45YmUx
5+
about: Join our Telegram community for general questions and discussions
6+
- name: 🔒 Security Vulnerability
7+
url: mailto:dstack@phala.network
8+
about: Report security vulnerabilities privately via email
9+
- name: 📖 Documentation
10+
url: https://docs.phala.network/dstack
11+
about: Check the official Dstack documentation
12+
- name: ❓ GitHub Discussions
13+
url: https://github.com/Dstack-TEE/dstack-examples/discussions
14+
about: Ask questions and discuss ideas with the community

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Documentation Issue
2+
description: Report an issue with documentation
3+
title: "[DOCS] "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation! Please describe the issue below.
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation needs attention?
16+
options:
17+
- Example README
18+
- Main README
19+
- Contributing Guidelines
20+
- Security Documentation
21+
- Code Comments
22+
- Other
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: location
28+
attributes:
29+
label: Documentation Location
30+
description: Where is the documentation issue located?
31+
placeholder: e.g., "attestation/configid-based/README.md", "CONTRIBUTING.md", etc.
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
id: issue-type
37+
attributes:
38+
label: Issue Type
39+
description: What type of documentation issue is this?
40+
options:
41+
- Incorrect Information
42+
- Missing Information
43+
- Unclear Instructions
44+
- Broken Links
45+
- Outdated Content
46+
- Typo/Grammar
47+
- Formatting Issue
48+
- Other
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: description
54+
attributes:
55+
label: Issue Description
56+
description: Describe the documentation issue
57+
placeholder: What's wrong with the documentation?
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: current-content
63+
attributes:
64+
label: Current Content (if applicable)
65+
description: Copy the current problematic content
66+
placeholder: Paste the current content here...
67+
render: markdown
68+
69+
- type: textarea
70+
id: suggested-fix
71+
attributes:
72+
label: Suggested Fix
73+
description: How should this be corrected?
74+
placeholder: What should the content say instead?
75+
render: markdown
76+
77+
- type: textarea
78+
id: context
79+
attributes:
80+
label: Additional Context
81+
description: Any additional context that might help
82+
placeholder: |
83+
- How did you encounter this issue?
84+
- What were you trying to accomplish?
85+
- Any related issues?
86+
87+
- type: checkboxes
88+
id: contribution
89+
attributes:
90+
label: Contribution
91+
options:
92+
- label: I'm willing to submit a PR to fix this documentation issue
93+
required: false

‎.github/ISSUE_TEMPLATE/example_submission.yml‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
name: Example Submission
2+
description: Submit a new example for review
3+
title: "[EXAMPLE] "
4+
labels: ["new-example", "needs-review"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for contributing a new example! Please fill out this form to help us review your submission.
10+
11+
- type: input
12+
id: example-name
13+
attributes:
14+
label: Example Name
15+
description: What is the name of your example?
16+
placeholder: e.g., "secure-file-storage"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Example Description
24+
description: What does your example demonstrate?
25+
placeholder: |
26+
Provide a clear description of:
27+
- What the example does
28+
- What Dstack/TEE features it showcases
29+
- What problem it solves
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: category
35+
attributes:
36+
label: Example Category
37+
description: Which category does your example fit into?
38+
options:
39+
- Security & Attestation
40+
- Networking & Domains
41+
- Development Tools
42+
- Advanced Use Cases
43+
- Blockchain Integration
44+
- Other
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: difficulty
50+
attributes:
51+
label: Difficulty Level
52+
description: What's the complexity level of this example?
53+
options:
54+
- Beginner
55+
- Intermediate
56+
- Advanced
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: technologies
62+
attributes:
63+
label: Technologies Used
64+
description: List the main technologies, frameworks, or tools used
65+
placeholder: |
66+
- Docker/Docker Compose
67+
- Programming languages
68+
- Frameworks
69+
- External services
70+
- etc.
71+
render: markdown
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: prerequisites
77+
attributes:
78+
label: Prerequisites
79+
description: What are the prerequisites for running this example?
80+
placeholder: |
81+
- Required knowledge
82+
- Software dependencies
83+
- Hardware requirements
84+
- Account setups (if any)
85+
render: markdown
86+
87+
- type: textarea
88+
id: security-features
89+
attributes:
90+
label: Security Features
91+
description: What TEE/security features does this example demonstrate?
92+
placeholder: |
93+
- Remote attestation
94+
- Secure communication
95+
- Secret management
96+
- Privacy preservation
97+
- etc.
98+
render: markdown
99+
100+
- type: checkboxes
101+
id: checklist
102+
attributes:
103+
label: Submission Checklist
104+
description: Please confirm you've completed these items
105+
options:
106+
- label: I've followed the example structure guidelines from CONTRIBUTING.md
107+
required: true
108+
- label: I've included a comprehensive README.md
109+
required: true
110+
- label: I've tested the example and it works correctly
111+
required: true
112+
- label: I've included necessary environment variable examples
113+
required: true
114+
- label: I've documented security considerations
115+
required: true
116+
- label: I've followed security best practices
117+
required: true
118+
- label: My example doesn't contain hardcoded secrets
119+
required: true
120+
121+
- type: textarea
122+
id: testing
123+
attributes:
124+
label: Testing Information
125+
description: How have you tested this example?
126+
placeholder: |
127+
- Testing environments used
128+
- Test scenarios covered
129+
- Known limitations
130+
- Troubleshooting tested
131+
validations:
132+
required: true
133+
134+
- type: textarea
135+
id: additional
136+
attributes:
137+
label: Additional Notes
138+
description: Any additional information for reviewers
139+
placeholder: |
140+
- Special considerations
141+
- Future improvements planned
142+
- Related examples
143+
- etc.

0 commit comments

Comments
 (0)