Initial commit
This commit is contained in:
commit
7b53e80217
81 changed files with 39132 additions and 0 deletions
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Bug Description
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## Reproduction Steps
|
||||
Steps to reproduce the behavior:
|
||||
1. Initialize BrainyData with '...'
|
||||
2. Call method '....'
|
||||
3. See error
|
||||
|
||||
## Expected Behavior
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
## Environment
|
||||
- Brainy version: [e.g. 0.9.4]
|
||||
- Environment: [e.g. Browser, Node.js, serverless]
|
||||
- Browser (if applicable): [e.g. Chrome, Safari]
|
||||
- Node.js version (if applicable): [e.g. 23.11.0]
|
||||
- Operating System: [e.g. Windows 10, macOS Monterey, Ubuntu 22.04]
|
||||
|
||||
## Additional Context
|
||||
Add any other context about the problem here. If applicable, include code snippets, error messages, or screenshots.
|
||||
|
||||
## Possible Solution
|
||||
If you have suggestions on how to fix the issue, please describe them here.
|
||||
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
A clear and concise description of what problem this feature would solve. For example: "I'm always frustrated when [...]"
|
||||
|
||||
## Proposed Solution
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
## Alternative Solutions
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
## Use Case
|
||||
Describe a concrete use case that highlights the value of this feature.
|
||||
|
||||
## Additional Context
|
||||
Add any other context, code examples, or references about the feature request here.
|
||||
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
## Description
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
|
||||
|
||||
Fixes # (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)
|
||||
- [ ] Documentation update
|
||||
- [ ] Performance improvement
|
||||
- [ ] Code refactoring (no functional changes)
|
||||
|
||||
## How Has This Been Tested?
|
||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
|
||||
|
||||
## 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
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
44
.github/workflows/deploy-demo.yml
vendored
Normal file
44
.github/workflows/deploy-demo.yml
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
name: Deploy Demo to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node.js 🔧
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies 📦
|
||||
run: npm install --legacy-peer-deps
|
||||
|
||||
- name: Build project 🏗️
|
||||
run: |
|
||||
npm run build
|
||||
npm run build:browser
|
||||
|
||||
- name: Prepare deployment 📦
|
||||
run: |
|
||||
mkdir -p deploy
|
||||
mkdir -p deploy/demo
|
||||
cp index.html deploy/
|
||||
cp demo/index.html deploy/demo/
|
||||
cp -r dist deploy/
|
||||
cp brainy.png deploy/
|
||||
|
||||
- name: Deploy to GitHub Pages 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@v4
|
||||
with:
|
||||
folder: deploy
|
||||
branch: gh-pages
|
||||
Loading…
Add table
Add a link
Reference in a new issue