flowmind 1.4.6 → 1.4.8

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.4.8] - 2026-06-30
+
+### Changed
+- Simplified the npm homepage README into a short entry page focused on positioning, quick start, and next-step links
+- Moved the longer product explanation into dedicated guide documents for English and Chinese readers
+- Added packaged detailed guide documents so linked deep-dive docs resolve from the published npm package
+
+## [1.4.7] - 2026-06-30
+
+### Added
+- npm package now ships the demo assets and integration guide referenced by the README
+
+### Changed
+- Release packaging now excludes local promotion copy so community post drafts do not get published to npm
+- Demo setup now reads the package version dynamically instead of keeping a stale hardcoded value
+
 ## [1.4.6] - 2026-06-30
 
 ### Added

package/CONTRIBUTING.md

@@ -0,0 +1,236 @@
+# Contributing to FlowMind
+
+Thank you for your interest in contributing to FlowMind! 🎉
+
+## 🤝 Ways to Contribute
+
+- 🐛 **Report bugs** - Help us identify issues
+- 💡 **Suggest features** - Share your ideas
+- 📝 **Improve docs** - Make documentation better
+- 🛠️ **Add skills** - Create new capabilities
+- 🌍 **Translations** - Help localize
+- 🧪 **Write tests** - Improve quality
+
+## 🚀 Getting Started
+
+### 1. Fork & Clone
+
+```bash
+git clone https://github.com/your-username/flowmind.git
+cd flowmind
+```
+
+### 2. Install Dependencies
+
+```bash
+npm install
+```
+
+### 3. Create Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+### 4. Make Changes
+
+Make your changes, following our coding standards.
+
+### 5. Test
+
+```bash
+npm test
+```
+
+### 6. Submit PR
+
+Push your changes and create a pull request.
+
+## 📝 Coding Standards
+
+### Code Style
+
+- Use ESLint for JavaScript
+- Follow Prettier formatting
+- Write meaningful commit messages
+
+### Commit Messages
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer]
+```
+
+Types:
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation
+- `style`: Formatting
+- `refactor`: Code refactoring
+- `test`: Adding tests
+- `chore`: Maintenance
+
+### Testing
+
+- Write unit tests for new features
+- Ensure all tests pass
+- Aim for >80% coverage
+
+```bash
+npm test
+npm run test:coverage
+```
+
+## 🛠️ Creating Skills
+
+### Skill Structure
+
+```
+skills/
+└── your-skill/
+    ├── SKILL.md        # Skill definition
+    ├── index.js        # Implementation
+    └── tests/          # Tests
+```
+
+### Skill Definition (SKILL.md)
+
+```markdown
+---
+name: your-skill
+description: What this skill does
+metadata:
+  version: "1.0.0"
+  author: your-name
+  category: your-category
+---
+
+# Your Skill
+
+## Trigger Conditions
+When should this skill activate?
+
+## Features
+What does this skill do?
+
+## Examples
+How to use this skill?
+```
+
+### Skill Implementation (index.js)
+
+```javascript
+module.exports = {
+  name: 'your-skill',
+  version: '1.0.0',
+
+  canHandle(input, context) {
+    // Return true if this skill should handle the input
+    return input.includes('your-trigger');
+  },
+
+  async execute(input, context) {
+    // Implement skill logic
+    return {
+      success: true,
+      data: { /* results */ }
+    };
+  }
+};
+```
+
+## 📚 Documentation
+
+### Writing Guidelines
+
+- Use clear, concise language
+- Include code examples
+- Add diagrams where helpful
+- Keep documentation up-to-date
+
+### Documentation Structure
+
+```
+docs/
+├── getting-started.md
+├── configuration.md
+├── skills.md
+├── learning.md
+├── architecture.md
+└── api-reference.md
+```
+
+## 🧪 Testing Guidelines
+
+### Unit Tests
+
+```javascript
+describe('YourFeature', () => {
+  it('should do something', async () => {
+    const input = {};
+    const result = await yourFunction(input);
+    expect(result).toBeDefined();
+  });
+});
+```
+
+### Integration Tests
+
+```javascript
+describe('Skill Integration', () => {
+  it('should work with learning system', async () => {
+    // Test skill + learning integration
+  });
+});
+```
+
+## 🚀 Release Process
+
+1. Update version in package.json
+2. Update CHANGELOG.md
+3. Create release branch
+4. Run full test suite
+5. Create GitHub release
+6. Publish to npm
+
+## 📋 PR Checklist
+
+Before submitting:
+
+- [ ] Code follows style guidelines
+- [ ] Tests are written and passing
+- [ ] Documentation is updated
+- [ ] Commit messages are clear
+- [ ] No breaking changes (or documented)
+
+## 🏷️ Issue Labels
+
+- `bug`: Something isn't working
+- `enhancement`: New feature or request
+- `documentation`: Documentation improvements
+- `good first issue`: Good for newcomers
+- `help wanted`: Extra attention needed
+
+## 📞 Getting Help
+
+- **GitHub Discussions**: Questions and discussions
+- **GitHub Issues**: Bug reports and features
+- **Discord**: Community chat
+
+## 🎉 Recognition
+
+Contributors will be:
+- Listed in CONTRIBUTORS.md
+- Mentioned in release notes
+- Invited to maintainer team (significant contributions)
+
+## 📄 License
+
+By contributing, you agree your contributions will be licensed under MIT License.
+
+---
+
+Thank you for contributing to FlowMind! 🚀