2023-10-10 17:00:18 +08:00

18 lines
767 B
Markdown

# Contributing to phpgeo
Note: It's a good idea to [open an issue](https://github.com/mjaschen/phpgeo/issues)
for bugs or feature proposals first.
The contribution workflow is described as follows:
1. Fork phpgeo, clone repository (`git clone git@github.com:yourname/phpgeo.git`)
2. Checkout your feature or bug-fix branch (e. g. `git checkout -b fix-random-bug`)
3. Install dependencies: `composer install`
4. Add tests for your changes
5. Make your changes
6. Run the tests (`composer ci`)
7. Iterate through steps 3 to 5 until all tests pass.
8. Commit your changes (`git add -A -- . && git commit`)
9. Push to your fork (`git push --set-upstream origin fix-random-bug`)
10. Create a pull request from your feature or bug-fix branch to phpgeo's "master" branch