Contributing to LRAgent
Thank you for your interest in contributing! We welcome contributions of all kinds.
Quick Start
- Fork the repository
- Create a feature branch:
git checkout -b feat/my-feature - Make your changes
- Run checks:
pnpm lint && pnpm build - Submit a pull request
Code Style
- JavaScript: CommonJS (
require/module.exports), no TypeScript in server/ - Frontend: Vue 3 Composition API,
, kebab-case file names - Naming:
- Files:
kebab-case(e.g.,use-exec-log.js,staff-feedback-card.vue) - Domain objects: English (
Part,BOM,ECO,Vendor) - Properties:
snake_case(item_number,quality_score) - UI text: Chinese (zh-CN is the primary language)
- No comments unless explaining "why", not "what"
What to Contribute
Always Welcome (MIT-licensed core)
- Bug fixes
- New intent rules for the Intent Engine
- New rule-engine inspection rules
- New composable hooks
- Performance improvements
- Documentation and examples
Requires Discussion (Enterprise boundary)
- New PLM/ARAS integrations
- Industry-specific digital staff
- Enterprise features (SSO, RBAC, audit)
Open an issue first if you're unsure which category your contribution falls into.
Pull Request Process
- One PR, one concern — Don't mix features and refactors
- Add tests if adding new functionality
- Update documentation if changing public APIs
- Keep PRs small — Under 500 lines changed is ideal
- Write clear commit messages —
feat:,fix:,docs:,refactor:
Reporting Bugs
- Check existing issues first
- Include: Node.js version, OS, steps to reproduce, expected vs actual behavior
- Include server logs if available
Feature Requests
Open a discussion or issue with the feature label. Describe:
- Problem: What pain point does this solve?
- Proposal: How should it work?
- Scope: Core (MIT) or Enterprise?
Code of Conduct
- Be respectful and constructive
- Focus on the code, not the person
- Help newcomers get started
Questions?
- Open a GitHub issue
- Join our Discord
- Reach out on X (Twitter)
BossAgents