Skip to content

Commit 5b712df

Browse files
committed
Starts to add contributing code.
1 parent 6f9de70 commit 5b712df

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

.github/CONTRIBUTING.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -53,34 +53,32 @@ Documentation is how users learn about the framework, and developers begin to un
5353
> We welcome contributions of any size! Feel free to submit a pull request, even if it's just fixing a typo or adding a sentence.
5454
5555
To contribute to Tempest's documentation, please:
56-
- Head over to the [Tempest docs repository](https://github.com/tempestphp/tempest-docs) to fork the project.
57-
- Add or edit any relevant documentation in a manner consistent with the rest of the documentation.
58-
- Re-read what you wrote and run it through a spell checker.
59-
- Open a pull request with your changes.
56+
* Head over to the [Tempest docs repository](https://github.com/tempestphp/tempest-docs) to fork the project.
57+
* Add or edit any relevant documentation in a manner consistent with the rest of the documentation.
58+
* Re-read what you wrote and run it through a spell checker.
59+
* Open a pull request with your changes.
6060

6161
Once a pull request has been opened, the Tempest team will:
6262
* Use GitHub reviews to review your pull request.
6363
* If necessary, ask for revisions.
64-
* If we decide to pass on your pull request, we thank you for your contribution and explain our decision. We appreciate all the time contributors put into Tempest!
64+
* If we decide to pass on your pull request, we will thank you for your contribution and explain our decision. We appreciate all the time contributors put into Tempest!
6565
* If your pull request is accepted, we will mark it as such and merge it into the project.
6666

67-
---
68-
69-
We welcome your PRs and contributions. If you have any feature requests or bug reports, head over to the [issue page](https://github.com/tempestphp/tempest-framework/issues) and feel free to create an issue.
70-
71-
If you'd like to send PRs, you can check out and run Tempest locally like so:
72-
73-
```php
74-
git clone [email protected]:tempestphp/tempest-framework.git
75-
cd tempest-framework/
76-
composer update
77-
```
78-
79-
Before submitting PRs, run `composer qa` locally:
80-
81-
```php
82-
composer qa
83-
```
67+
## Contribute Code
68+
We cannot wait to get your pull request! To make the most of your time, please ensure that any contributions pertain to an approved feature request or a confirmed bug. This helps us focus on the vision for Tempest and ensuring the best developer experience.
69+
70+
To contribute to Tempest's code, please:
71+
* [Setup Tempest Locally](#setup-tempest-locally)
72+
* Make the relevant code changes.
73+
* Run `composer qa` to ensure you are meeting the necessary style guidelines.
74+
* Push your changes to your fork and make a pull request.
75+
76+
### Setup Tempest Locally
77+
* Go to the [Tempest GitHub repository](https://github.com/tempestphp/tempest-framework) and click the **Fork** button in the top-right corner of the page. This creates a copy of the project on your GitHub account.
78+
* See the [GitHub Documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) for more information on forking a repository.
79+
* Clone your forked repository by running `git clone [email protected]:{my_github_username}/tempest-framework.git`.
80+
* Enter the Tempest directory (`cd tempest-framework`) and install the composer dependencies (`composer update`).
81+
* You're ready to get started!
8482

8583
Please see below for some general guidelines relating to specific components of the framework.
8684

0 commit comments

Comments
 (0)