Skip to content

Commit bc49c49

Browse files
authored
chore: improve readme and update labels (#895)
1 parent 15f8995 commit bc49c49

File tree

5 files changed

+64
-26
lines changed

5 files changed

+64
-26
lines changed
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
name: Bug Report
1+
name: Bug report
22
description: Report a bug or error, providing details about the issue, steps to reproduce, and your environment setup.
3-
title: "[Bug]: "
4-
labels: ['Triage', 'Bug']
3+
labels: ['Triage']
4+
type: 'Bug'
55
body:
66
- type: input
77
attributes:
8-
label: Tempest Version
8+
label: Tempest version
99
description: Provide the Tempest version that you are using.
10-
value: 1.0-alpha1
10+
value: 1.0-alpha.4
1111
validations:
1212
required: true
1313
- type: dropdown
1414
attributes:
15-
label: PHP Version
15+
label: PHP version
1616
description: Provide the PHP version that you are using.
1717
options: ['8.4']
1818
multiple: true
1919
validations:
2020
required: true
2121
- type: dropdown
2222
attributes:
23-
label: Operating System
23+
label: Operating system
2424
description: Provide the operating system that you are using.
25-
options: ['Linux', 'MacOS', 'Windows', 'Other']
25+
options: ['Linux', 'macOS', 'Windows', 'Other']
2626
multiple: true
2727
validations:
2828
required: true
@@ -34,7 +34,7 @@ body:
3434
required: true
3535
- type: textarea
3636
attributes:
37-
label: Steps to Reproduce
38-
description: Please provide detailed steps on how we can reproduce the issue you are reporting. For a shot at getting our "Perfect Storm" label, submit a PR with a failing test!
37+
label: Steps to reproduce
38+
description: Please provide detailed steps on how we can reproduce the issue you are reporting. For a shot at getting our "Perfect storm" label, submit a PR with a failing test!
3939
validations:
4040
required: true

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name: Feature Request
1+
name: Feature request
22
description: Tempest is a work in progress! Let us know about a feature you would like to see in the framework.
3-
title: "[Feature Request]: "
4-
labels: ['Triage', 'Feature Request']
3+
labels: ['Triage']
4+
type: 'Feature'
55
body:
66
- type: textarea
77
attributes:

.github/workflows/close-stale.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ jobs:
1717
exempt-all-milestones: true
1818
days-before-stale: 30
1919
days-before-close: 1
20-
stale-issue-label: "stale"
20+
stale-issue-label: "Stale"
2121
stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
2222
close-issue-message: "This issue was closed because it has been inactive for 1 day since being marked as stale."
23-
stale-pr-label: "stale"
23+
stale-pr-label: "Stale"
2424
stale-pr-message: "This pull request is stale because it has been open for 30 days with no activity."
2525
close-pr-message: "This pull request was closed because it has been inactive for 1 day since being marked as stale."
2626
repo-token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
1-
# The PHP framework that gets out of your way.
1+
<p align="center">
2+
<a href="https://tempestphp.com">
3+
<img src=".github/tempest-logo.svg" width="100" />
4+
</a>
5+
</p>
26

3-
Tempest is a PHP framework that gets out of your way. Its design philosophy is that developers should write as little framework-related code as possible, so that they can focus on application code instead. Zero config, zero overhead. This is Tempest:
7+
<h1 align="center">Tempest</h1>
8+
<div align="center">
9+
The PHP framework that lets you focus on your application code instead of framework quirks.
10+
<br />
11+
Read the <a href="https://tempestphp.com">documentation</a> to get started.
12+
</div>
13+
14+
<br />
15+
<br />
16+
17+
## Introduction
18+
19+
Tempest is a PHP framework that _gets out of your way_.
20+
21+
Its design philosophy is that developers should write as little framework-related code as possible, so that they can focus on application code instead.
22+
23+
Zero config, zero overhead. This is Tempest:
424

525
```php
626
final class BookController
@@ -18,7 +38,7 @@ final class BookController
1838

1939
return new Redirect([self::class, 'show'], book: $book->id);
2040
}
21-
41+
2242
// …
2343
}
2444
```
@@ -53,24 +73,40 @@ final class MigrateUpCommand
5373

5474
Read how to get started with Tempest [here](https://tempestphp.com).
5575

76+
&nbsp;
77+
5678
## Installation
5779

58-
Install Tempest in any project, including existing projects:
80+
Create a Tempest project from scratch:
5981

6082
```
61-
composer require tempest/framework:1.0-alpha.4
83+
composer create-project tempest/app:1.0-alpha.4 <name>
6284
```
6385

64-
Or create a Tempest project from scratch:
86+
Or install Tempest in any existing project:
6587

6688
```
67-
composer create-project tempest/app:1.0-alpha.4 <name>
89+
composer require tempest/framework:1.0-alpha.4
6890
```
6991

7092
Continue to read how Tempest works in [the docs](https://tempestphp.com).
7193

72-
## Contributing
94+
&nbsp;
7395

74-
We welcome contributing to the Tempest framework! We only ask that you take a quick look at our [guidelines](https://tempestphp.com/docs/internals/contributing/) and then head on over to the issues page to see some ways you might help out!
96+
## Contributing
7597

76-
For more information, [join the Tempest Discord](https://tempestphp.com/discord)
98+
We welcome contributing to Tempest! We only ask that you take a quick look at our [guidelines](https://tempestphp.com/docs/internals/contributing/).
99+
100+
An easy way to get started is to head on over to the issues page to see some ways you might help out.
101+
102+
<p align="center">
103+
<br />
104+
<br />
105+
<sub>
106+
Check out the <a href="https://tempestphp.com">documentation</a>
107+
&nbsp;
108+
·
109+
&nbsp;
110+
Join the <a href="https://tempestphp.com/discord">Discord</a> server
111+
</sub>
112+
</p>

eslint.config.mjs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
import defineEslintConfig from '@innocenzi/eslint-config'
22

3-
export default defineEslintConfig()
3+
export default defineEslintConfig({
4+
ignores: ['.github', 'public', '*.json'],
5+
})

0 commit comments

Comments
 (0)