Skip to content

Commit 79faf81

Browse files
gregghClaude
greggh
and
Claude
committed
Add: GitHub best practices documentation
Add the following documentation files to adhere to GitHub best practices: - CODE_OF_CONDUCT.md - Establishes community standards - SECURITY.md - Security policy and vulnerability reporting - SUPPORT.md - Support channels and resources - ROADMAP.md - Future development plans - LICENSE - MIT License - .editorconfig - Consistent coding styles 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 5070989 commit 79faf81

File tree

6 files changed

+254
-0
lines changed

6 files changed

+254
-0
lines changed

‎.editorconfig

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# EditorConfig helps maintain consistent coding styles across different editors
2+
# https://editorconfig.org/
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
indent_style = space
12+
indent_size = 2
13+
14+
# Markdown files
15+
[*.md]
16+
trim_trailing_whitespace = false
17+
18+
# Lua files
19+
[*.lua]
20+
indent_size = 2
21+
22+
# VimL files
23+
[*.vim]
24+
indent_size = 2
25+
26+
# YAML files
27+
[*.{yml,yaml}]
28+
indent_size = 2
29+
30+
# Shell scripts
31+
[*.sh]
32+
indent_size = 2
33+
34+
# Make files
35+
[Makefile]
36+
indent_style = tab

‎CODE_OF_CONDUCT.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to making participation in our project a positive and respectful experience for everyone.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive feedback
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior include:
18+
19+
* Unwelcome comments or actions
20+
* Trolling, insulting/derogatory comments, and personal attacks
21+
* Publishing others' private information without explicit permission
22+
* Other conduct which could reasonably be considered inappropriate
23+
24+
## Our Responsibilities
25+
26+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
27+
28+
## Scope
29+
30+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
31+
32+
## Enforcement
33+
34+
Instances of unacceptable behavior may be reported by contacting the project team through GitHub. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
35+
36+
## Attribution
37+
38+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023-2025 Gregg Housh
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎ROADMAP.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Laravel Helper Roadmap
2+
3+
This document outlines the planned development path for Laravel Helper. It's divided into short-term, medium-term, and long-term goals. This roadmap may evolve over time based on user feedback and project priorities.
4+
5+
## Short-term Goals (Next 3 months)
6+
7+
- **Core Feature Expansion**: Enhance key Laravel development features
8+
- Add Artisan command autocompletion
9+
- Implement Blade template snippets
10+
- Add Laravel model relationship navigation
11+
12+
- **Test Coverage**: Improve test coverage for existing functionality
13+
- Create tests for all command functionality
14+
- Implement integration tests for Laravel projects
15+
- Add window navigation tests
16+
17+
- **Documentation**: Enhance user and developer documentation
18+
- Create better examples in help documentation
19+
- Add screenshots and GIFs to README
20+
- Improve inline code documentation
21+
22+
## Medium-term Goals (3-12 months)
23+
24+
- **Laravel Ecosystem Integration**: Expand beyond core Laravel
25+
- Add support for popular Laravel packages (Livewire, Inertia, etc.)
26+
- Create integrations for Laravel Nova
27+
- Support Laravel Sail environments
28+
29+
- **Code Generation**: Implement intelligent code generation
30+
- Generate Laravel models from database schema
31+
- Create view templates from controllers
32+
- Build test stubs for Laravel components
33+
34+
- **Debugging Integration**: Improve Laravel debugging experience
35+
- Add Laravel log file integration
36+
- Implement Xdebug configuration helpers
37+
- Create Laravel-specific DAP configurations
38+
39+
## Long-term Goals (12+ months)
40+
41+
- **AI-assisted Laravel Development**: Leverage AI for Laravel
42+
- Add context-aware AI suggestions for Laravel code
43+
- Implement intelligent refactoring for Laravel components
44+
- Create AI-powered documentation lookup
45+
46+
- **Laravel Project Management**: Comprehensive project tools
47+
- Create project scaffolding tools
48+
- Implement dependency management
49+
- Build deployment helpers for Laravel applications
50+
51+
## Completed Goals
52+
53+
- Basic Laravel navigation functionality
54+
- Implementation of core helper commands
55+
- Creation of comprehensive test framework
56+
- CI/CD workflow implementation
57+
58+
## Feature Requests and Contributions
59+
60+
If you have feature requests or would like to contribute to the roadmap, please:
61+
62+
1. Check if your idea already exists as an issue on GitHub
63+
2. If not, open a new issue with the "enhancement" label
64+
3. Explain how your idea would benefit Laravel developers
65+
66+
We welcome community contributions to help achieve these goals! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute.

‎SECURITY.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The following versions of Laravel Helper are currently supported with security updates:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 0.3.x | :white_check_mark: |
10+
| 0.2.x | :white_check_mark: |
11+
| < 0.2 | :x: |
12+
13+
## Reporting a Vulnerability
14+
15+
We take the security of Laravel Helper seriously. If you believe you've found a security vulnerability, please follow these steps:
16+
17+
1. **Do not disclose the vulnerability publicly**
18+
2. **Open a private vulnerability report** through the GitHub repository's Security tab
19+
- Include steps to reproduce
20+
- Include potential impact
21+
- If possible, include suggestions for remediation
22+
3. **Allow time for response and remediation**
23+
- We aim to respond to security reports within 72 hours
24+
- We'll keep you updated on our progress addressing the issue
25+
26+
## Security Response Process
27+
28+
When a security vulnerability is reported:
29+
30+
1. We will confirm receipt of the vulnerability report
31+
2. We will investigate and validate the reported issue
32+
3. We will develop and test a fix
33+
4. We will release a security update
34+
5. We will publicly disclose the issue after a fix is available
35+
36+
## Security Best Practices for Users
37+
38+
- Keep Laravel Helper updated to the latest supported version
39+
- Regularly update Neovim and related plugins
40+
- Be cautious when using Laravel Helper with untrusted Laravel projects
41+
- Follow secure coding practices in your Laravel applications
42+
43+
## Security Updates
44+
45+
Security updates will be released as:
46+
- Patch versions for supported releases
47+
- Announcements in our release notes
48+
- Updates to the CHANGELOG.md file
49+
50+
## Past Security Advisories
51+
52+
No formal security advisories have been issued for this project yet.

‎SUPPORT.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Support
2+
3+
This document outlines the various ways you can get help with Laravel Helper.
4+
5+
## GitHub Discussions
6+
7+
For general questions, ideas, or community discussions, please use [GitHub Discussions](https://github.com/greggh/laravel-helper/discussions).
8+
9+
Categories:
10+
- **Q&A**: For specific questions about using Laravel Helper
11+
- **Ideas**: For suggesting new features
12+
- **Show and Tell**: For sharing your customizations or use cases
13+
- **General**: For general conversation about Laravel development with Neovim
14+
15+
## Issue Tracker
16+
17+
For reporting bugs or requesting features, please use the [GitHub issue tracker](https://github.com/greggh/laravel-helper/issues).
18+
19+
Before creating a new issue:
20+
1. Search existing issues to avoid duplicates
21+
2. Use the appropriate issue template
22+
3. Provide as much detail as possible, including Neovim version, Laravel version, and Laravel Helper version
23+
24+
## Documentation
25+
26+
For help with using Laravel Helper:
27+
- Read the [README.md](README.md) for basic usage and installation
28+
- Check the [DEVELOPMENT.md](DEVELOPMENT.md) for development information
29+
- See the [doc/laravel-helper.txt](doc/laravel-helper.txt) for Neovim help documentation
30+
31+
## Community Channels
32+
33+
- GitHub Discussions is the primary community channel for this project
34+
35+
## Contributing
36+
37+
If you're interested in contributing to the project, please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
38+
39+
## Security Issues
40+
41+
For security-related issues, please refer to our [SECURITY.md](SECURITY.md) document for proper disclosure procedures.

0 commit comments

Comments
 (0)