You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .ai/core.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,4 +5,5 @@ The Laravel Boost Guidelines are specifically curated by Laravel maintainers for
5
5
{project.purpose}
6
6
</purpose-of-this-project>
7
7
8
-
TODO: Add project structure / relevant models / etc.. ? Kind of like Claude's /init, but for every Laravel developer regardless of IDE ? But if they already have that in Claude.md then that's gonna be doubling up and wasting tokens
8
+
# Conventions
9
+
Follow existing conventions. When creating or editing a file, check sibling files for the correct structure, approach, naming.
> This is a template repository for new Laravel AI
11
-
> Assistants. [Start a new repo with this](https://github.com/laravel/boost/generate), clone it locally and search &
12
-
> replace the relevant things below:
13
-
>
14
-
> -`Laravel AI Assistant` with the package name (e.g. `Laravel Horizon`)
15
-
> -`boost` references to the vendor name / GitHub url (e.g. `laravel/horizon`) (*)
16
-
> -`boost` references to the publishing name (e.g. `horizon`) (*)
17
-
> -`Laravel\Boost` references to the package namespace (e.g. `Laravel\Horizon`) (*)
18
-
> -`Boost` references to the short package name (e.g. `Horizon`) (*)
19
-
> -`BOOST_` references to the env variable names (e.g. `HORIZON`) (*)
20
-
>
21
-
> (*) Name cannot contain spaces.
22
-
>
23
-
> After replacing keywords, take the following steps:
24
-
>
25
-
> 1. Rename any `Boost` prefixes in `.php` file names in [`src`](./src) to the package name (e.g. `Horizon`)
26
-
> 2. Remove things you don't need like migrations, routes, resources, etc
27
-
> 3. Fill the package short intro and keywords in the [composer.json](./composer.json) file
28
-
> 4. Set the same short intro and keywords in the GitHub repository sidebar and set the website url to the package docs
29
10
> 5. Fill out the package long introduction in the readme
30
-
> 6. Set the correct link to the docs in the readme
31
11
> 7. Replace the `art/logo.svg` with the new package logo
32
12
> 8. Replace the `public/favicon.ico` with the new package favicon (optional)
33
13
> 9. Remove this quote block from your readme
34
-
>
35
-
> All that's left for you is to start building your new package! 🛠
14
+
> 10. Write a great README
36
15
37
16
## Introduction
38
17
39
-
Package introduction...
40
-
./artisan vendor:publish --tag=boost-config
18
+
-`composer require laravel/boost`
19
+
-`./artisan vendor:publish --tag=boost-config`
20
+
-`./artisan boost:install`
21
+
22
+
> [!IMPORTANT]
23
+
> Boost is currently in Beta, is subject to change prior to the v1.0.0 release, and will be updated frequently. All notable changes will be documented in the [changelog](./CHANGELOG.md).
41
24
42
25
## Official Documentation
43
26
44
27
Documentation for Boost can be found on the [Laravel website](https://laravel.com/docs).
45
28
46
29
## Contributing
47
30
48
-
Thank you for considering contributing to Boost! The contribution guide can be found in
49
-
the [Laravel documentation](https://laravel.com/docs/contributions).
31
+
Thank you for considering contributing to Boost! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
50
32
51
33
## Code of Conduct
52
34
53
-
In order to ensure that the Laravel community is welcoming to all, please review and abide by
54
-
the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
35
+
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
55
36
56
37
## Security Vulnerabilities
57
38
58
-
Please review [our security policy](https://github.com/laravel/envoy/security/policy) on how to report security
59
-
vulnerabilities.
39
+
Please review [our security policy](https://github.com/laravel/boost/security/policy) on how to report security vulnerabilities.
// TODO: Add package info, php version, laravel version, existing approaches, directory structure, models? General Laravel guidance that applies to all projects somehow? 'Follow existing conventions - if you are creating or editing a file, check sibling files for structure/approach/naming
121
+
// TODO: Add project structure / relevant models / etc.. ? Kind of like Claude's /init, but for every Laravel developer regardless of IDE ? But if they already have that in Claude.md then that's gonna be doubling up and wasting tokens
111
122
])]);
112
123
113
124
if (str_contains(config('app.url'), '.test') && $this->isHerdInstalled()) {
@@ -116,44 +127,61 @@ protected function compose(): string
116
127
]));
117
128
}
118
129
119
-
// TODO: Improve • this is a horrible way to do this
Copy file name to clipboardExpand all lines: src/Contracts/Ide.php
+1-6Lines changed: 1 addition & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,5 @@ interface Ide
7
7
{
8
8
// Things to note: supports relative (absolute path required)? global mcp only? Prefer local file, but if global only we have to add the project name to the server name
0 commit comments