diff --git a/.husky/pre-commit b/.husky/pre-commit index c5c3dfc..5ec0971 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,5 +1,2 @@ -#!/usr/bin/env sh -. "$(dirname -- "$0")/_/husky.sh" - npm run lint npm run format:check diff --git a/app/layout.tsx b/app/layout.tsx index 6c2d3c1..a3d202e 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -39,13 +39,14 @@ export default function RootLayout({ children }: { children: ReactNode }) { return ( - Test Case Generator - + Assertify + +
@@ -59,13 +60,14 @@ export default function RootLayout({ children }: { children: ReactNode }) { return ( - Test Case Generator - + Assertify + + diff --git a/contributing.md b/contributing.md index 01286a1..f8ea32d 100644 --- a/contributing.md +++ b/contributing.md @@ -3,16 +3,19 @@ Thanks for considering a contribution to Assertify! This document outlines how to set up a local environment, the coding standards we follow, and what we expect from every pull request. ## Ways to Contribute + - Report bugs or request features by opening an Issue with clear reproduction steps or user stories. - Improve documentation, copy, or accessibility anywhere in the repo. - Tackle open Issues that are tagged `good first issue`, `help wanted`, or any topic you feel comfortable owning. ## Prerequisites + - **Node.js 18.x** and the matching npm release (the CI pipeline pins Node 18). - An OpenAI API key stored in `.env.local` so you can exercise AI-powered features locally. - `git` and GitHub access so you can fork and open pull requests. ## Local Development + 1. Fork the repository on GitHub and clone your fork. 2. Install dependencies: `npm install`. 3. Copy the example environment file: `cp .env.example .env.local`, then add your OpenAI API key. @@ -20,11 +23,13 @@ Thanks for considering a contribution to Assertify! This document outlines how t 5. Run `npm run build` before opening a pull request to ensure Next.js can compile. ## Branching, Commits, and Style + - Create feature branches off `master` using the pattern `type/short-description` (e.g., `feat/context-questions`). -- Keep commits focused; prefer smaller commits that describe *why* a change exists. +- Keep commits focused; prefer smaller commits that describe _why_ a change exists. - Follow the existing TypeScript, React, and Tailwind conventions already present in the code you touch. ## Quality Checks + The GitHub Actions workflow (`.github/workflows/ci.yml`) runs linting and formatting on every pull request. Run the same commands locally before pushing: ```bash @@ -35,6 +40,7 @@ npm run format:check Use `npm run format` to auto-format files. Please fix all warnings or explain why they cannot be resolved in the pull request description. ## Pull Request Checklist + - [ ] Explain the motivation and link the Issue being addressed. - [ ] Include screenshots or recordings for UI changes (desktop + mobile where relevant). - [ ] Update documentation (README, docs, or component stories) when behavior changes. @@ -42,12 +48,15 @@ Use `npm run format` to auto-format files. Please fix all warnings or explain wh - [ ] Request at least one review and be responsive to feedback. ## Reporting Issues + When filing an Issue, include: + - Expected vs. actual behavior and reproduction steps. - Environment details (OS, browser, Node version) if applicable. - Logs, stack traces, or screenshots that make the problem easier to diagnose. ## Questions + Unsure about the best approach or need clarification before opening a PR? Start a GitHub Discussion or comment on the related Issue so we can align on a solution before you invest significant time. Happy testing! diff --git a/public/favicon.svg b/public/favicon.svg new file mode 100644 index 0000000..ba6e474 --- /dev/null +++ b/public/favicon.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + +