Skip to content

Commit e8badc2

Browse files
theshadow76theshadow76
authored
Merge pull request #1 from ChipaDevTeam/copilot/create-professional-files
Add professional project infrastructure and documentation
2 parents d989ca3 + 6da5fb6 commit e8badc2

28 files changed

Lines changed: 3415 additions & 1 deletion

‎.dockerignore‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Git
2+
.git
3+
.gitignore
4+
.gitattributes
5+
6+
# Python
7+
__pycache__
8+
*.py[cod]
9+
*$py.class
10+
*.so
11+
.Python
12+
*.egg-info
13+
dist
14+
build
15+
venv/
16+
.venv/
17+
ENV/
18+
env/
19+
20+
# Model files (large files)
21+
*.pth
22+
*.pt
23+
*.onnx
24+
25+
# Data
26+
data/
27+
datasets/
28+
*.csv
29+
*.parquet
30+
31+
# Logs
32+
*.log
33+
logs/
34+
35+
# IDE
36+
.vscode
37+
.idea
38+
*.swp
39+
*.swo
40+
41+
# Documentation build
42+
docs/_build
43+
44+
# Tests
45+
.pytest_cache
46+
.coverage
47+
htmlcov
48+
49+
# OS
50+
.DS_Store
51+
Thumbs.db
52+
53+
# Temporary
54+
tmp/
55+
temp/
56+
*.tmp
57+
*.bak
58+
59+
# Docker
60+
.dockerignore
61+
Dockerfile
62+
docker-compose.yml
63+
64+
# CI/CD
65+
.github/
66+
.gitlab-ci.yml
67+
68+
# Documentation
69+
*.md
70+
docs/
71+
LICENSE

‎.editorconfig‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# EditorConfig helps maintain consistent coding styles across different editors
2+
# https://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
[*.{py,pyx,pxd}]
13+
indent_style = space
14+
indent_size = 4
15+
max_line_length = 100
16+
17+
[*.{json,yml,yaml}]
18+
indent_style = space
19+
indent_size = 2
20+
21+
[*.md]
22+
trim_trailing_whitespace = false
23+
max_line_length = off
24+
25+
[Makefile]
26+
indent_style = tab
27+
28+
[*.{sh,bash}]
29+
indent_style = space
30+
indent_size = 2

‎.github/FUNDING.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
# github: [ChipaDevTeam]
4+
# patreon: # Replace with a single Patreon username
5+
# open_collective: # Replace with a single Open Collective username
6+
# ko_fi: # Replace with a single Ko-fi username
7+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
# liberapay: # Replace with a single Liberapay username
10+
# issuehunt: # Replace with a single IssueHunt username
11+
# otechie: # Replace with a single Otechie username
12+
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Bug Report
2+
description: Report a bug or issue with WinstonAI
3+
title: "[BUG] "
4+
labels: ["bug", "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.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Run command '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What you expected to happen
37+
placeholder: Describe what should have happened...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened
46+
placeholder: Describe what actually happened...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: Environment
54+
description: Please provide your environment details
55+
placeholder: |
56+
- OS: [e.g., Ubuntu 22.04, Windows 11]
57+
- Python version: [e.g., 3.10.5]
58+
- PyTorch version: [e.g., 2.0.1]
59+
- GPU: [e.g., RTX 3060 Ti, None]
60+
- CUDA version: [e.g., 11.8, N/A]
61+
- WinstonAI version: [e.g., 1.1.0]
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: logs
67+
attributes:
68+
label: Error Logs
69+
description: Please provide relevant error messages or logs
70+
render: shell
71+
placeholder: Paste error logs here...
72+
73+
- type: textarea
74+
id: additional
75+
attributes:
76+
label: Additional Context
77+
description: Add any other context about the problem here
78+
placeholder: Any additional information...
79+
80+
- type: checkboxes
81+
id: checklist
82+
attributes:
83+
label: Pre-submission Checklist
84+
options:
85+
- label: I have searched for similar issues before creating this one
86+
required: true
87+
- label: I have provided all the requested information
88+
required: true
89+
- label: I have tested with the latest version of WinstonAI
90+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for WinstonAI
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like
25+
placeholder: I would like to see...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered
34+
placeholder: I have also considered...
35+
36+
- type: textarea
37+
id: use-case
38+
attributes:
39+
label: Use Case
40+
description: Describe your use case and how this feature would benefit you and others
41+
placeholder: This would help me to...
42+
validations:
43+
required: true
44+
45+
- type: dropdown
46+
id: category
47+
attributes:
48+
label: Feature Category
49+
description: Which area does this feature relate to?
50+
options:
51+
- Model Architecture
52+
- Training Pipeline
53+
- Live Trading
54+
- Risk Management
55+
- GPU Optimization
56+
- Data Processing
57+
- Documentation
58+
- Testing
59+
- Other
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: additional
65+
attributes:
66+
label: Additional Context
67+
description: Add any other context, screenshots, or examples about the feature request
68+
placeholder: Additional information...
69+
70+
- type: checkboxes
71+
id: checklist
72+
attributes:
73+
label: Pre-submission Checklist
74+
options:
75+
- label: I have searched for similar feature requests before creating this one
76+
required: true
77+
- label: This feature aligns with the goals of WinstonAI
78+
required: true
79+
- label: I am willing to help implement this feature if needed
80+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Question
2+
description: Ask a question about WinstonAI
3+
title: "[QUESTION] "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Have a question? We're here to help! Please fill out the form below.
10+
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: Your Question
15+
description: What would you like to know?
16+
placeholder: How do I...
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: category
22+
attributes:
23+
label: Question Category
24+
description: Which area does your question relate to?
25+
options:
26+
- Installation & Setup
27+
- Training Models
28+
- Live Trading
29+
- GPU Configuration
30+
- API Integration
31+
- Data Processing
32+
- Configuration
33+
- General Usage
34+
- Other
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: context
40+
attributes:
41+
label: Additional Context
42+
description: Provide any additional context that might help us answer your question
43+
placeholder: I am trying to...
44+
45+
- type: textarea
46+
id: attempted
47+
attributes:
48+
label: What Have You Tried?
49+
description: Tell us what you've already tried or researched
50+
placeholder: I have tried...
51+
52+
- type: checkboxes
53+
id: checklist
54+
attributes:
55+
label: Pre-submission Checklist
56+
options:
57+
- label: I have searched existing issues and discussions for similar questions
58+
required: true
59+
- label: I have read the README and relevant documentation
60+
required: true

0 commit comments

Comments
 (0)