-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontributing.py
More file actions
95 lines (67 loc) Β· 2.21 KB
/
contributing.py
File metadata and controls
95 lines (67 loc) Β· 2.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# Create CONTRIBUTING.md
contributing = '''# Contributing to DevSuite
Thank you for your interest in contributing to DevSuite! We welcome contributions from the community.
## How to Contribute
### Reporting Bugs
- Check if the bug has already been reported in the Issues section
- If not, create a new issue with a clear title and description
- Include steps to reproduce, expected behavior, and actual behavior
- Add screenshots if applicable
### Suggesting Features
- Open an issue with the label `enhancement`
- Describe the feature and its use case
- Explain why this feature would be useful
### Pull Requests
1. Fork the repository
2. Create a new branch: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Run tests: `npm test`
5. Commit your changes: `git commit -m 'Add some feature'`
6. Push to the branch: `git push origin feature/your-feature-name`
7. Open a Pull Request
### Development Setup
```bash
# Clone the repository
git clone https://github.com/yourusername/devsuite.git
cd devsuite
# Install dependencies
npm install
npm install --workspaces
# Run CLI in development
npm run dev:cli
# Run Web app
npm run dev:web
# Run API Directory
npm run dev:api
```
### Code Style
- Use TypeScript for type safety
- Follow existing code patterns
- Add JSDoc comments for functions
- Use meaningful variable names
- Keep functions small and focused
### Commit Message Guidelines
- Use present tense: "Add feature" not "Added feature"
- Use imperative mood: "Move cursor to..." not "Moves cursor to..."
- Limit first line to 72 characters
- Reference issues and PRs where appropriate
### Testing
- Add tests for new features
- Ensure all tests pass before submitting PR
- Maintain or improve code coverage
## Project Structure
```
devsuite/
βββ packages/
β βββ cli/ # DevToolkit CLI
β βββ web/ # Snippet Vault
β βββ api-directory/ # API Graveyard
```
## Questions?
Feel free to open an issue for any questions or join our discussions.
## License
By contributing, you agree that your contributions will be licensed under the MIT License.
'''
with open(f"{base_path}/CONTRIBUTING.md", "w") as f:
f.write(contributing)
print("β
CONTRIBUTING.md created")