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: .github/CONTRIBUTING.md
+20-22Lines changed: 20 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,34 +53,32 @@ Documentation is how users learn about the framework, and developers begin to un
53
53
> 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.
54
54
55
55
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.
60
60
61
61
Once a pull request has been opened, the Tempest team will:
62
62
* Use GitHub reviews to review your pull request.
63
63
* 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!
65
65
* If your pull request is accepted, we will mark it as such and merge it into the project.
66
66
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:
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!
84
82
85
83
Please see below for some general guidelines relating to specific components of the framework.
0 commit comments