Skip to content

Add contribution guidelines, issue and PR templates, and CI workflow#8

Merged
jpdevhub merged 5 commits into
mainfrom
setupdoc
May 13, 2026
Merged

Add contribution guidelines, issue and PR templates, and CI workflow#8
jpdevhub merged 5 commits into
mainfrom
setupdoc

Conversation

@jpdevhub

Copy link
Copy Markdown
Owner

Summary

This PR implements all necessary open-source repository guidelines to prepare the project for external contributors.

Motivation

To ensure the project meets enterprise open-source standards, providing a seamless onboarding experience for new developers, enforcing code quality through automated CI/CD, and formalizing the contribution process.

@vercel

vercel Bot commented May 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
fresh-scan-ai Ready Ready Preview, Comment May 13, 2026 6:48am

@jpdevhub jpdevhub merged commit d61cda9 into main May 13, 2026
5 checks passed
@jpdevhub jpdevhub requested a review from Copilot May 26, 2026 06:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR prepares the repository for external contributors by adding core open-source contribution assets (license, contributing guide, issue/PR templates) and introducing a GitHub Actions CI workflow to enforce baseline frontend/backend quality checks.

Changes:

  • Added repository hygiene and contributor onboarding assets: LICENSE, CONTRIBUTING.md, and GitHub issue/PR templates.
  • Added CI workflow to run frontend lint/build and backend Ruff + lightweight pytest smoke tests.
  • Performed assorted formatting/lint-driven updates across frontend and backend files (plus a couple of auth-related React lifecycle adjustments).

Reviewed changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
src/pages/AuthPage.tsx Adjusts OAuth redirect handling/state transitions during auth callback parsing.
src/components/Navbar.tsx Adds an “ignore” guard to avoid setting profile state after effect cleanup.
README.md Reworks README structure/content for onboarding, setup, and OSS readiness.
LICENSE Adds an MIT license file.
eslint.config.js Expands ignore patterns (e.g., macOS metadata files).
CONTRIBUTING.md Adds contribution process, conventions, and local workflow guidance.
backend/upload_test.py Whitespace/formatting cleanup.
backend/tests/test_ci.py Introduces lightweight backend CI smoke tests (no torch/model/server needed).
backend/test_pipeline.py Minor import/formatting cleanup in ML pipeline verification script.
backend/test_auth.py Improves formatting/readability of integration test script output and requests.
backend/seed_vendors.py Formats long print statement for readability.
backend/ruff.toml Adds Ruff configuration for backend linting in CI.
backend/router.py Removes unused import and minor formatting cleanup.
backend/requirements.txt Adds pytest to backend requirements.
backend/main.py Formatting refactors, minor readability improvements, and a small select-string refactor.
backend/inference.py Formatting cleanup and docstring wrapping.
backend/fusion.py Formatting cleanup and function signature wrapping.
backend/auto_test.py Formatting cleanup for readability.
backend/auth.py Removes unused import.
.github/workflows/ci.yml Adds CI workflow (frontend lint/build + backend Ruff + smoke tests).
.github/PULL_REQUEST_TEMPLATE.md Adds PR template checklist and required sections.
.github/ISSUE_TEMPLATE/good_first_issue.yml Adds “Good First Issue” issue form.
.github/ISSUE_TEMPLATE/feature_request.yml Adds feature request issue form.
.github/ISSUE_TEMPLATE/bug_report.yml Adds bug report issue form.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/pages/AuthPage.tsx
Comment on lines 21 to 35
if (error) {
setStatus('error');
setErrorMsg('Authentication failed. Please try again.');
Promise.resolve().then(() => {
setStatus('error');
setErrorMsg('Authentication failed. Please try again.');
});
window.history.replaceState({}, '', '/auth');
return;
}

if (accessToken) {
setStatus('processing');
Promise.resolve().then(() => setStatus('processing'));
setToken(accessToken);
// Clean the URL
window.history.replaceState({}, '', '/auth');
navigate('/mode', { replace: true });
return;
Comment thread src/components/Navbar.tsx
.catch(console.error);
} else {
setProfile(null);
Promise.resolve().then(() => { if (!ignore) setProfile(null); });
Comment thread README.md
<br />
<a href="https://github.com/jpdevhub/FreshScanAi/issues/new?labels=bug">Report Bug</a>
&middot;
<a href="https://github.com/jpdevhub/FreshScanAi/issues/new?labels=enhancement">Request Feature</a>
Comment thread CONTRIBUTING.md

- Ensure your branch is up to date with `main`
- Run `npm run lint` and fix all errors
- Run the backend tests with `python -m pytest backend/` and ensure they pass

## Checklist
- [ ] `npm run lint` passes
- [ ] Backend tests pass (`python -m pytest backend/`)
Comment thread .github/workflows/ci.yml
Comment on lines +62 to +70
- name: Install dependencies
run: |
pip install fastapi uvicorn supabase Pillow numpy \
python-dotenv python-multipart httpx pytest

- name: Lint with Ruff
run: |
pip install ruff
ruff check . --config ruff.toml
@jpdevhub jpdevhub deleted the setupdoc branch June 2, 2026 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants