Skip to content

Commit

Permalink
Simplify CONTRIBUTING part of README
Browse files Browse the repository at this point in the history
  • Loading branch information
luispabon committed Nov 22, 2021
1 parent 57c92cf commit aa66ac0
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,10 @@ This is the repository for both the website and the generator over at [PHPDocker
Contributing
------------

The usual Github model of forking and pull request. We're following trunk based development, so please create your branches against the `master` branch. There are no unit tests to keep an eye on, but until I get a functional suite testing ready, code merges can take a while.

All I ask is to thoroughly test, manually, any changes made to the generators. You will need to run the containers with example apps to ensure they're working. Functional tests in the future will do precisely this, with a combination of PHP versions, frameworks, databases, etc. Setting this up is an area you could contribute on.

If you would like to add new containers, please either base them on `alpine` images, `debian:jessie` (used by many official images such as MySQL, ElasticSearch...) or Ubuntu 16.04 as these are in use for the generated environments and will optimise deployment and provisioning to users.
Fork, tweak & pull request.

Please follow PSR code formatting standards, and Symfony best practices and, in general, do what you see already done in the current code.

Please note everything is really in very early stages; if you see anything at all you can improve upon, please do so.

Running the project
-------------------

Expand Down

0 comments on commit aa66ac0

Please sign in to comment.