Skip to content

Commit e5d6cd5

Browse files
author
Test User
committed
Release version 0.3.0
### Added - Changes in CONTRIBUTING.md - Changes in DOCS.md - Changes in img/logo-reactstream1.svg - Changes in img/logo-reactstream2.svg - Changes in img/logo-reactstream2t.svg
1 parent 30bb384 commit e5d6cd5

7 files changed

Lines changed: 785 additions & 1 deletion

File tree

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.3.0] - 2024-11-26
6+
7+
### Added
8+
- Changes in CONTRIBUTING.md
9+
- Changes in DOCS.md
10+
- Changes in img/logo-reactstream1.svg
11+
- Changes in img/logo-reactstream2.svg
12+
- Changes in img/logo-reactstream2t.svg
13+
514
## [0.2.0] - 2024-11-26
615

716
### Added

‎CONTRIBUTING.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
# Contributing to ReactStream
2+
3+
## 👋 Welcome!
4+
5+
Thank you for considering contributing to ReactStream! This document provides guidelines and instructions for contributing to the project.
6+
7+
## 🗺 Getting Started
8+
9+
1. **Fork the Repository**
10+
```bash
11+
# Clone your fork
12+
git clone https://github.com/YOUR_USERNAME/reactstream.git
13+
14+
# Add upstream remote
15+
git remote add upstream https://github.com/original/reactstream.git
16+
```
17+
18+
2. **Set Up Development Environment**
19+
```bash
20+
# Install dependencies
21+
npm install
22+
23+
# Run development server
24+
npm run dev
25+
26+
# Run tests
27+
npm test
28+
```
29+
30+
## 🏗 Project Structure
31+
32+
```
33+
reactstream/
34+
├── src/
35+
│ ├── core/ # Core functionality
36+
│ ├── analyzer/ # Code analysis tools
37+
│ ├── components/ # UI components
38+
│ └── utils/ # Helper functions
39+
├── bin/ # CLI tools
40+
├── tests/ # Test files
41+
└── docs/ # Documentation
42+
```
43+
44+
## 🔍 Development Guidelines
45+
46+
### Code Style
47+
48+
- Follow the existing code style
49+
- Use ESLint and Prettier configurations
50+
- Write meaningful commit messages
51+
- Include JSDoc comments for functions
52+
53+
### Commits
54+
55+
Format: `type(scope): description`
56+
57+
Types:
58+
- `feat`: New feature
59+
- `fix`: Bug fix
60+
- `docs`: Documentation
61+
- `style`: Formatting
62+
- `refactor`: Code restructuring
63+
- `test`: Tests
64+
- `chore`: Maintenance
65+
66+
Example:
67+
```
68+
feat(analyzer): add performance metrics tracking
69+
```
70+
71+
### Testing
72+
73+
- Write tests for new features
74+
- Update existing tests when modifying code
75+
- Ensure all tests pass before submitting PR
76+
- Maintain test coverage above 80%
77+
78+
### Documentation
79+
80+
- Update README.md if needed
81+
- Document new features
82+
- Update API documentation
83+
- Include JSDoc comments
84+
85+
## 🚀 Pull Request Process
86+
87+
1. **Create Feature Branch**
88+
```bash
89+
git checkout -b feature/your-feature-name
90+
```
91+
92+
2. **Make Changes**
93+
- Write code
94+
- Add tests
95+
- Update documentation
96+
97+
3. **Commit Changes**
98+
```bash
99+
git add .
100+
git commit -m "feat(scope): description"
101+
```
102+
103+
4. **Update from Upstream**
104+
```bash
105+
git fetch upstream
106+
git rebase upstream/main
107+
```
108+
109+
5. **Push and Create PR**
110+
```bash
111+
git push origin feature/your-feature-name
112+
```
113+
114+
Then create PR through GitHub interface.
115+
116+
## 🐛 Bug Reports
117+
118+
Please include:
119+
- Clear description
120+
- Steps to reproduce
121+
- Expected vs actual behavior
122+
- Environment details
123+
- Screenshots if applicable
124+
125+
## 🎯 Feature Requests
126+
127+
Include:
128+
- Clear description of feature
129+
- Use cases
130+
- Expected behavior
131+
- Mockups/examples if applicable
132+
133+
## 📋 Code Review Process
134+
135+
1. **Initial Review**
136+
- Code style
137+
- Test coverage
138+
- Documentation
139+
- Performance impact
140+
141+
2. **Technical Review**
142+
- Architecture
143+
- Security
144+
- Performance
145+
- Edge cases
146+
147+
3. **Final Review**
148+
- Integration testing
149+
- Documentation completeness
150+
- Breaking changes
151+
152+
## 🏷 Release Process
153+
154+
1. **Version Bump**
155+
```bash
156+
npm version [patch|minor|major]
157+
```
158+
159+
2. **Generate Changelog**
160+
```bash
161+
npm run changelog
162+
```
163+
164+
3. **Create Release**
165+
```bash
166+
git tag -a v1.x.x -m "Version 1.x.x"
167+
git push origin v1.x.x
168+
```
169+
170+
## 📘 Code of Conduct
171+
172+
### Our Pledge
173+
174+
We pledge to make participation in our project a harassment-free experience for everyone.
175+
176+
### Our Standards
177+
178+
- Use welcoming language
179+
- Be respectful of differing viewpoints
180+
- Accept constructive criticism
181+
- Focus on what is best for the community
182+
- Show empathy towards other community members
183+
184+
### Enforcement
185+
186+
- First violation: Warning
187+
- Second violation: Temporary ban
188+
- Third violation: Permanent ban
189+
190+
## 📄 License
191+
192+
By contributing, you agree that your contributions will be licensed under the project's MIT License.

‎DOCS.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# ReactStream Documentation
2+
3+
## Overview
4+
ReactStream is a comprehensive development and analysis toolkit for React components. It consists of two main tools:
5+
1. ReactStream DevServer - For real-time component development and testing
6+
2. ReactStream Analyzer - For code analysis, debugging, and optimization
7+
8+
## Installation
9+
10+
```bash
11+
# Global installation
12+
npm install -g reactstream
13+
14+
# Local project installation
15+
npm install --save-dev reactstream
16+
```
17+
18+
## Quick Start
19+
20+
```bash
21+
# Start development server
22+
reactstream MyComponent.js --port=3000
23+
24+
# Analyze component
25+
reactstream-analyze MyComponent.js --debug
26+
```
27+
28+
## ReactStream DevServer Features
29+
30+
### Component Development
31+
- Hot Module Replacement (HMR)
32+
- Isolated component testing
33+
- Built-in UI component library
34+
- Automatic dependency management
35+
- Real-time preview
36+
- Custom port configuration
37+
38+
### Built-in Components
39+
- Card system
40+
- Tab navigation
41+
- Alert components
42+
- Form elements
43+
- Layout utilities
44+
45+
### Development Environment
46+
- Automatic setup and cleanup
47+
- Webpack configuration
48+
- Babel integration
49+
- CSS processing
50+
- Asset handling
51+
52+
## ReactStream Analyzer Features
53+
54+
### Code Analysis
55+
- Syntax validation
56+
- Best practices checking
57+
- Hook rules verification
58+
- Performance optimization
59+
- Accessibility testing
60+
61+
### Debugging Tools
62+
- Automatic debugger insertion
63+
- State tracking
64+
- Effect monitoring
65+
- Performance profiling
66+
67+
### Optimization
68+
- Component comparison
69+
- Code duplication detection
70+
- Import optimization
71+
- Performance suggestions
72+
73+
## Configuration
74+
75+
### DevServer Config
76+
```javascript
77+
{
78+
port: 3000,
79+
hot: true,
80+
open: true,
81+
components: {
82+
path: './src/components',
83+
extensions: ['.js', '.jsx']
84+
}
85+
}
86+
```
87+
88+
### Analyzer Config
89+
```javascript
90+
{
91+
debug: false,
92+
fix: false,
93+
verbose: false,
94+
rules: {
95+
'react-hooks/rules-of-hooks': 'error',
96+
'react-hooks/exhaustive-deps': 'warn'
97+
}
98+
}
99+
```
100+
101+
## CLI Commands
102+
103+
### Development Server
104+
```bash
105+
reactstream [component] [options]
106+
107+
Options:
108+
--port Port number (default: 3000)
109+
--no-open Don't open browser
110+
--debug Enable debug mode
111+
```
112+
113+
### Analyzer
114+
```bash
115+
reactstream-analyze [component] [options]
116+
117+
Options:
118+
--debug Enable debug mode
119+
--fix Auto-fix issues
120+
--verbose Detailed output
121+
--compare Compare components
122+
```
123+
124+
## Best Practices
125+
126+
1. Component Development
127+
- Use isolated testing
128+
- Enable HMR for faster development
129+
- Utilize built-in components
130+
- Follow file naming conventions
131+
132+
2. Code Analysis
133+
- Run analyzer before commits
134+
- Address critical issues first
135+
- Review performance suggestions
136+
- Maintain accessibility standards
137+
138+
3. Optimization
139+
- Regular code analysis
140+
- Component comparisons
141+
- Performance monitoring
142+
- Regular dependency updates
143+
144+
## Troubleshooting
145+
146+
Common Issues:
147+
1. Port conflicts
148+
2. Dependency mismatches
149+
3. Build errors
150+
4. HMR issues
151+

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
![logo-reactstream2.svg](img/logo-reactstream2.svg)
12

23
Przykład użycia:
34

@@ -60,4 +61,4 @@ Aby połączyć oba narzędzia, możesz użyć:
6061

6162
# Następnie uruchomienie z debuggerem
6263
./reactstream MyComponent.js --port=3000 --debug
63-
```
64+
```

0 commit comments

Comments
 (0)