5a79f1a2eb
- Implemented SiteHeader and SiteFooter components for consistent navigation and footer across the website. - Created CommunityPage and ContributePage to provide information on community involvement and contribution guidelines. - Developed DocsPage to serve as the main documentation hub, detailing features and installation instructions. - Added HomePage to introduce LexAI and its functionalities, highlighting key features and privacy aspects. - Established links.ts for centralized management of external links used throughout the website. - Configured main.tsx for application entry point with React Router for navigation. - Introduced styles.css for consistent styling across the website. - Set up TypeScript configuration files for improved type checking and development experience. - Configured Vite for building and serving the website.
2.9 KiB
Contributing to LexAI
Thanks for helping improve LexAI. This project is a monorepo with three user-facing packages plus a shared library.
Code of Conduct
Please read and follow the Code of Conduct.
Ways to contribute
- Bug reports and reproducible issues
- Documentation fixes
- Small, focused pull requests (one concern per PR)
- Discussions on design when a change is large or security-sensitive
Development setup
Requirements: Node.js 22+, npm 11+ (see packageManager in root package.json).
git clone https://git.juankibin.space/kibin/LexAI.git
cd LexAI
npm run install:all
Useful scripts (from repo root)
| Script | Purpose |
|---|---|
npm run chrome:dev |
Chrome extension with hot reload |
npm run chrome:build |
Production Chrome build |
npm run chrome:typecheck / chrome:test |
Typecheck & unit tests |
npm run vscode:build / vscode:typecheck |
VS Code extension |
npm run cli:build / cli:typecheck |
CLI Prompt Builder |
npm run typecheck:all / build:all |
All packages |
Shared code lives in src/lib/. Do not import @lib/crypto or @lib/messaging from packages/vscode or packages/cli (Chrome-only).
Package-specific notes
- Chrome: load unpacked from
packages/chrome/.output/chrome-mv3after build. Selection/replace is DOM-timing-sensitive — verify on a real page for UI changes. - VS Code: build then F5 or Install from VSIX (
packages/vscode). - CLI: set
LEXAI_API_KEY; never commit keys or put them in~/.lexai/config.json.
CI
Gitea Actions runs one workflow per package (path-filtered):
| Workflow | Package |
|---|---|
.gitea/workflows/ci-chrome.yml |
packages/chrome (+ src/lib, tests) |
.gitea/workflows/ci-vscode.yml |
packages/vscode (+ src/lib) |
.gitea/workflows/ci-cli.yml |
packages/cli (+ src/lib) |
.gitea/workflows/ci-website.yml |
packages/website |
Deploy / preview / release workflows are not enabled yet.
Pull request process
- Fork / branch from
main(ordevelopif that is the active integration branch). - Keep changes scoped; update docs when behavior changes.
- Run the checks that touch your change, at minimum:
- Shared lib / Chrome:
npm run chrome:typecheckandnpm run chrome:test - VS Code:
npm run vscode:typecheckandnpm run vscode:build - CLI:
npm run cli:typecheckandnpm run cli:build
- Shared lib / Chrome:
- Open a PR using the pull request template.
- Do not include secrets, API keys, or personal data in commits or screenshots.
Security
If you discover a vulnerability (especially around API key handling or data exfiltration), do not open a public issue with exploit details. Contact the maintainer privately (see the Chrome Web Store listing / repository owner).
License
By contributing, you agree that your contributions will be licensed under the MIT License.