Skip to content

Commit 6f9de70

Browse files
committed
Adds documentation section.
1 parent e70852e commit 6f9de70

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Welcome aboard! We're excited that you are interested in contributing to the Tem
66
* [🐞 An Error or Bug](#report-an-error-or-bug)
77
* [💡 A Feature](#request-a-feature)
88
* Make...
9-
* [📖 A Contribution to Documentation]()
9+
* [📖 A Contribution to Documentation](#contribute-documentation)
1010
* [🔨 A Contribution to the Code]()
1111
* Manage...
1212
* [❓ Issues and Pull Requests]()
@@ -43,9 +43,27 @@ Once the feature request has been opened, the Tempest team will:
4343
* Ask any clarifying question to help better understand the use case.
4444
* If the feature requested is accepted, the Tempest team will assign the "Uncharted Waters" label. A Tempest team member or a member of the community can contribute the code for this.
4545

46-
> [!NOTE]
46+
> [!IMPORTANT]
4747
> We welcome all contributions and greatly value your time and effort. To ensure your work aligns with Tempest's vision and avoids unnecessary effort, we aim to provide clear guidance and feedback throughout the process.
4848
49+
## Contribute Documentation
50+
Documentation is how users learn about the framework, and developers begin to understand how Tempest works under the hood. It's critical to everything we do! Thank you in advance for your assistance in ensuring Tempest documentation is extensive, user-friendly, and up-to-date.
51+
52+
> [!NOTE]
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+
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.
60+
61+
Once a pull request has been opened, the Tempest team will:
62+
* Use GitHub reviews to review your pull request.
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!
65+
* If your pull request is accepted, we will mark it as such and merge it into the project.
66+
4967
---
5068

5169
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.

0 commit comments

Comments
 (0)