Skip to content

Commit 1aa0b8e

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

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Welcome aboard! We're excited that you are interested in contributing to the Tem
77
* [💡 A Feature](#request-a-feature)
88
* Make...
99
* [📖 A Contribution to Documentation](#contribute-documentation)
10-
* [🔨 A Contribution to the Code]()
10+
* [🔨 A Contribution to the Code](#contribute-code)
1111
* Manage...
1212
* [❓ Issues and Pull Requests]()
1313
* [📦 Sub-split packages]()
@@ -62,23 +62,39 @@ 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.
6464
* 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!
65-
* If your pull request is accepted, we will mark it as such and merge it into the project.
65+
* If your pull request is accepted, we will mark it as such and merge it into the project. It will be released in the next tagged version! 🎉
6666

6767
## 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.
68+
So you want to dive into the code! 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.
6969

7070
To contribute to Tempest's code, please:
71-
* [Setup Tempest Locally](#setup-tempest-locally)
71+
* [Setup Tempest Locally](#setting-up-tempest-locally)
7272
* 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!
73+
* Write tests that verify that your contribution works as expected.
74+
* Run `composer qa` to ensure you are adhering to our style guidelines.
75+
* Document your changes in the CHANGELOG following the [Keep a Changelog](https://keepachangelog.com) format.
76+
* Go to https://github.com/tempestphp/tempest-framework/pulls and create a pull request with your changes.
77+
* If your pull request is connected to an open issue, add a line in your description that says `Fixes: #xxx`, where `#xxx` is the number of the issue you're fixing.
78+
79+
Once a pull request has been opened, the Tempest team will:
80+
* Use GitHub reviews to review your pull request.
81+
* Ensure all CI pipelines are passing.
82+
* If necessary, ask for revisions.
83+
* 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!
84+
* If your pull request is accepted, we will mark it as such and merge it into the project. It will be released in the next tagged version! 🎉
85+
86+
### Setting up Tempest Locally
87+
* Install PHP
88+
* Install Composer
89+
* [Fork the Tempest repository.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
90+
91+
Then in your terminal:
92+
* `cd /path/to/your/clone`
93+
* `composer update`
94+
95+
You're ready to get started!
96+
97+
---
8298

8399
Please see below for some general guidelines relating to specific components of the framework.
84100

0 commit comments

Comments
 (0)