-
-
Notifications
You must be signed in to change notification settings - Fork 316
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- | ||
Thank you for contributing to Lychee! We only accept PR to the master branch. | ||
In addition, please describe the benefit to end users; the reasons it does not break any existing features, etc. | ||
If you're pushing a Feature: | ||
- Title it: "This new feature" | ||
- Describe what the new feature enables | ||
- Add tests to test the new feature. | ||
- Ensure it doesn't break any existing features. | ||
If you're pushing a Fix: | ||
- Title it: "Fixes the bug name" | ||
- If it is a fix an an existing issue start the description with `fixes #xxxx` where xxxx is the issue number. | ||
- Describe how it fixes in a few words. | ||
- Add a test that triggered the bug before fixing it. | ||
- Ensure it doesn't break any feature. | ||
All Pull Requests run with extensive tests for stable and latest versions of PHP. | ||
Ensure your tests pass or your PR may be taken down. | ||
Additionally you can run `make phpstan` and `make formatting` on your own machine as they will be required to pass for your PR to be accepted. | ||
Don't worry if your code styling isn't perfect! php-cs-fixer will automatically create a pull request with any style fixes. This allows us to focus on the content of the contribution and not the code style. | ||
--> |