Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 27 additions & 52 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,38 @@
---
name: Bug Report
about: Report a reproducible bug or issue to help improve BraveGoggles-Configuration-Standard-Development-Kit.
labels: ['bug', 'severity: medium']
assignees: ['chirag127']
---

## 🐞 Bug Report: BraveGoggles-Configuration-Standard-Development-Kit

Thank you for taking the time to report a bug! Your effort helps us maintain the quality and reliability of the `BraveGoggles-Configuration-Standard-Development-Kit`.

### Description

A clear and concise description of what the bug is. Be specific. What problem are you encountering?
about: Create a report to help us improve
title: "[BUG] "
labels: bug
assignees: ''

### Steps to Reproduce

Provide clear, step-by-step instructions to reproduce the issue. Include code snippets, configuration files, or detailed commands where relevant.
---

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error '....'
**Describe the bug**
A clear and concise description of what the bug is.

### Expected Behavior
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

### Actual Behavior

A clear and concise description of what actually happened, including any error messages or unexpected outputs.

### Screenshots / Recordings (Optional)

If applicable, add screenshots or a short video recording to help explain your problem. Visuals can significantly aid in understanding and diagnosing the issue.

### Environment

Please provide the following information about your environment:

* **Operating System:** [e.g., macOS Sonoma 14.2, Windows 11, Ubuntu 22.04 LTS]
* **BraveGoggles-Configuration-Standard-Development-Kit Version:** [e.g., `v1.0.0` or commit SHA]
* **Brave Browser Version:** [e.g., `1.60.118`]
* **Brave Search Goggles Configuration:** [Name of the Goggle(s) being used, if applicable]
* **Python Version (if applicable):** [e.g., `Python 3.10.12`]
* **Any other relevant software versions:**

### Severity

How critical is this bug? (Please select one by placing an 'x' in the brackets)

* [ ] **Critical:** The application or a major feature is completely broken or unusable.
* [ ] **High:** A significant feature is impaired, or data loss is possible. Major workflow disruption.
* [ ] **Medium:** A minor feature is broken or inconvenient, but there's a workaround. Moderate disruption.
* [ ] **Low:** Cosmetic issues, minor glitches, or non-critical functionality. Little to no disruption.

### Impact
**Screenshots**
If applicable, add screenshots to help explain your problem.

Describe the impact of this bug. Who does it affect, and how?
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Additional Context
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

Add any other context about the problem here. This could include things you've tried, other related issues, or specific scenarios where the bug occurs.
**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Pull Request
about: Propose a change to the project
title: "[FEAT] "
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
47 changes: 15 additions & 32 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,21 @@
# Security Policy for BraveGoggles-Configuration-Standard-Development-Kit

## Vulnerability Reporting

Brave Search is committed to the security of its users and the integrity of its products. We encourage responsible disclosure of security vulnerabilities. If you believe you have found a security issue in this repository, please report it via the following channels:

* **Primary Method:** Open a **private vulnerability report** through GitHub's security advisory feature. Navigate to the main page of this repository, click on the 'Security' tab, and then select 'Advisories' followed by 'New draft security advisory'. This ensures your report is handled securely and confidentially.
* **Alternative Method:** If you are unable to use GitHub's private reporting, please send an encrypted email to `security@brave.com` with the subject line "Security Vulnerability Report - BraveGoggles-Configuration-Standard-Development-Kit".

## Reporting Guidelines

When reporting a security vulnerability, please provide as much of the following information as possible:

* **Affected Repository:** `chirag127/BraveGoggles-Configuration-Standard-Development-Kit`
* **Description:** A clear and concise description of the vulnerability.
* **Steps to Reproduce:** Detailed steps to reproduce the vulnerability, including any necessary configuration or environment setup.
* **Proof of Concept (PoC):** If available, a minimal PoC demonstrating the vulnerability.
* **Impact Assessment:** Your assessment of the potential impact of the vulnerability.
* **Suggested Mitigation:** Any suggestions for how the vulnerability could be fixed.

## Disclosure Policy

We ask that you not disclose any vulnerabilities to the public until we have had a reasonable time to investigate and address the issue. Brave Search will strive to acknowledge receipt of your report within **48 hours** and will provide updates on the status of the investigation and resolution.

Once a vulnerability has been addressed, we will work with you to determine an appropriate time for public disclosure.
# Security Policy

## Supported Versions

This repository is actively maintained. We aim to address reported vulnerabilities in the latest stable version of the code. Security fixes may be backported to previous versions at our discretion.
Use this section to tell people about which versions of your project are
currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |

## What is NOT considered a security issue?
## Reporting a Vulnerability

* Findings of missing security headers (unless they allow for a specific, demonstrable exploit).
* Denial-of-Service (DoS) vulnerabilities that require a significant, unrealistic level of effort to execute.
* Issues that have been publicly disclosed already.
* Problems that are not specific to this repository's code (e.g., issues with third-party libraries that are not explicitly bundled or maintained by this project, unless a specific exploit is demonstrated).
Use this section to tell people how to report a vulnerability.

Thank you for helping keep the BraveGoggles-Configuration-Standard-Development-Kit secure!
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
10 changes: 10 additions & 0 deletions .github/badges.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
badges:
- name: Build Status
image: https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/ci.yml?label=Build&style=flat-square
url: https://github.com/{owner}/{repo}/actions/workflows/ci.yml
- name: License
image: https://img.shields.io/badge/License-CC%20BY--NC%204.0-blue.svg?style=flat-square
url: LICENSE
- name: GitHub Stars
image: https://img.shields.io/github/stars/{owner}/{repo}?style=flat-square
url: https://github.com/{owner}/{repo}
6 changes: 0 additions & 6 deletions .github/renovate.json

This file was deleted.

68 changes: 9 additions & 59 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,72 +1,22 @@
name: CI

# Apex Standard - December 2025
# Philosophy: Zero-Defect, High-Velocity, Future-Proof.

# Trigger on pushes to main branch and pull requests targeting main.
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build_and_test:
build:
runs-on: ubuntu-latest

strategy:
matrix:
# For Python projects, ensure compatibility across key versions.
python-version: ['3.10', '3.11', '3.12', '3.13']

steps:
- name: ⬆️ Checkout Repository
uses: actions/checkout@v4
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
with:
fetch-depth: 0 # Fetch all history for accurate blame/coverage

- name: 🐍 Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: 'uv'
cache-dependency-path: '**/uv.lock'

- name: 📦 Install Dependencies with uv
# uv is the Apex standard for Python dependency management.
run: |
python -m uv install --frozen --system
python -m uv pip freeze > requirements.txt

- name: 🧹 Lint and Format with Ruff
# Ruff is the Apex standard for ultra-fast linting and formatting.
run: |
python -m uv pip install ruff
ruff check . --fix
ruff format .

- name: 🧪 Run Tests with Pytest
# Pytest is the Apex standard for robust testing.
run: |
python -m uv pip install pytest
pytest tests/

- name: 📊 Generate Code Coverage
# Codecov is the Apex standard for coverage reporting.
# Assumes codecov.yml is configured for upload.
run: |
python -m uv pip install codecov
codecov --token $CODECOV_TOKEN
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
# Ensure this action can push to the correct repo context.
CI_NAME: github-actions
CI_SLUG: ${{ github.repository }}
CI_BRANCH: ${{ github.ref_name }}
CI_COMMIT: ${{ github.sha }}

# - name: 🚀 Deploy (Conditional)
# if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# # Add deployment steps here, e.g., to PyPI, internal registry, etc.
# # This requires additional secrets and configuration.
# run: echo "Deployment step placeholder."
node-version: '20.x'
cache: 'npm'
- run: npm install
- run: npm run lint
- run: npm run build --if-present
131 changes: 131 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-temporary-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build output
.nuxt
dist

# Docusaurus build output
.docusaurus

# Gatsby build output
.cache/
# Add history server for Gatsby Develop
.history/

# SvelteKit build output
.svelte-kit
.svelte

# Remix build output
.cache/
build/
public/build/

# Astro build output
dist/
.astro/

# Vite build output
dist

# Storybook build output
storybook-static

# Mitosis build output
dist/
.mitosis_cache/

# Deprecated Vitest cache directory
.vitest_cache

# Vitest cache directory
.vitest

# SolidStart build output
.solid/
dist/
.vite/
Loading
Loading