Skip to content

Commit ce0c7b2

Browse files
committed
docs: Add community files (SECURITY.md, CONTRIBUTING.md, issue templates, Dependabot)
1 parent c99dfc2 commit ce0c7b2

5 files changed

Lines changed: 79 additions & 529 deletions

File tree

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,39 @@
11
---
22
name: Bug Report
3-
about: Report a bug to help improve the project
4-
title: '[BUG] '
3+
about: Report a bug to help us improve
4+
title: '[Bug] '
55
labels: bug
6+
assignees: kochj23
67
---
78

8-
**Describe the bug**
9-
A clear description of what the bug is.
9+
## Description
10+
A clear description of the bug.
1011

11-
**To Reproduce**
12-
Steps to reproduce:
13-
1.
14-
2.
15-
3.
12+
## Steps to Reproduce
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. See error
1616

17-
**Expected behavior**
17+
## Expected Behavior
1818
What you expected to happen.
1919

20-
**Screenshots**
21-
If applicable, add screenshots.
20+
## Actual Behavior
21+
What actually happened.
2222

23-
**Environment:**
24-
- macOS version:
25-
- App version:
26-
- Hardware: [e.g., M1 MacBook Pro]
23+
## Environment
24+
- macOS version:
25+
- Apple Silicon chip (M1/M2/M3/M4):
26+
- MLX Code version:
27+
- Model being used:
28+
- RAM:
2729

28-
**Additional context**
30+
## Screenshots
31+
If applicable, add screenshots to help explain the problem.
32+
33+
## Additional Context
2934
Any other context about the problem.
35+
36+
## Security Assessment
37+
- [ ] This bug has security implications
38+
- [ ] This bug exposes sensitive data
39+
- [ ] This bug affects data integrity
Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
11
---
22
name: Feature Request
33
about: Suggest a new feature
4-
title: '[FEATURE] '
4+
title: '[Feature] '
55
labels: enhancement
6+
assignees: kochj23
67
---
78

8-
**Is your feature request related to a problem?**
9-
A clear description of the problem.
9+
## Description
10+
A clear description of the feature you'd like.
1011

11-
**Describe the solution you'd like**
12-
What you want to happen.
12+
## Use Case
13+
Why would this feature be useful? What problem does it solve?
1314

14-
**Alternatives considered**
15-
Any alternative solutions you've considered.
15+
## Proposed Solution
16+
How do you think this could be implemented?
1617

17-
**Additional context**
18-
Any other context or screenshots.
18+
## Alternatives Considered
19+
Any alternative solutions or features you've considered.
20+
21+
## Additional Context
22+
Any other context, screenshots, or mockups.
23+
24+
## Security Considerations
25+
- [ ] This feature handles user data
26+
- [ ] This feature requires network access
27+
- [ ] This feature interacts with the file system

.github/dependabot.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "github-actions"
3+
- package-ecosystem: "swift"
44
directory: "/"
55
schedule:
66
interval: "weekly"
7+
open-pull-requests-limit: 5

CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to MLXCode
1+
# Contributing to MLX Code
22

33
Thank you for your interest in contributing! We welcome contributions from the community.
44

@@ -19,23 +19,25 @@ Thank you for your interest in contributing! We welcome contributions from the c
1919
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
2020
3. Make your changes
2121
4. Ensure code compiles without warnings
22-
5. Test thoroughly on macOS
22+
5. Test thoroughly on macOS with Apple Silicon
2323
6. Commit with clear messages (`git commit -m 'feat: Add amazing feature'`)
2424
7. Push to your branch (`git push origin feature/amazing-feature`)
2525
8. Open a Pull Request
2626

2727
## Development Setup
2828

2929
### Requirements
30-
- macOS 13.0 (Ventura) or later
30+
- macOS 14.0 (Sonoma) or later
3131
- Xcode 15.0+
3232
- Swift 5.9+
33+
- Apple Silicon (M1/M2/M3/M4)
34+
- Python 3.9+ with `mlx-lm` installed
3335

3436
### Building
3537
```bash
3638
git clone https://github.com/kochj23/MLXCode.git
3739
cd MLXCode
38-
open *.xcodeproj
40+
open "MLX Code.xcodeproj"
3941
```
4042

4143
## Code Standards
@@ -49,13 +51,10 @@ open *.xcodeproj
4951
## Security
5052

5153
- **Never commit credentials, API keys, or secrets**
54+
- Store all secrets in macOS Keychain
5255
- Report security vulnerabilities privately (see [SECURITY.md](SECURITY.md))
5356
- Follow OWASP security best practices
5457

55-
## Code of Conduct
56-
57-
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code.
58-
5958
## License
6059

6160
By contributing, you agree that your contributions will be licensed under the MIT License.

0 commit comments

Comments
 (0)