This is a fun project intended to provide a safe environment in which to practice the mechanics of contributing to a GitHub project. It was spawn out of the PHP South Africa Conference. For more details, visit our homepage.
Come take part to get involved in Open Source, promote projects, win stickers and introduce yourself.
The conference is over and Pull Requests are now closed. If, however, you have any ideas or suggestions for next year please feel free to open an Issue - I'd love to hear from you
The master branch is regularly rolled out to production. It can be viewed online at http://www.phpsa2017profiles.co.za/
Fork this Repo
Extend the mostertb\PHPSA2017Profiles\Abstracts\AbstractProfile
class as mostertb\PHPSA2017Profiles\Profiles\<YourName>Profile
Implement the following methods:
- getName()
- getBiography()
- getGitHubUsername()
- getProfileImageURL() (optional)
- getMaintainedProjects() (optional)
- getInvolvedProjects() (optional)
If you get stuck, just look at someone else's Profile class for inspiration...
Run the PHPUnit test and check that they pass:
In the root directory of the project:
$ vendor/phpunit/phpunit/phpunit
Submit Pull Request (How TO | Pull Request from a fork)
Tweet your Pull Request @PHPSouthAfrica with the tag #PHPSA2017Profiles
This step is super important to the humor :)
PROFIT $$
Once your Pull Request is accepted, go say hi to Brad Mostert and he'll give you a GitHub sticker!
Now that you are one more 'OpenSource' contribution stronger, why not go have a look at Digital Ocean's Hacktoberfest initiative.
Alternatively, have a look at the projects that the other contributors to PHP South Africa 2017 Profile are involved in and go code with your fellow conference attendees
Why not also have a look at the TODO.md
file in this repository for ideas if you would like to continue to contribute to
this project
You can easily run a version of this project on your local dev environment by:
First running a composer install
to generate an autoloader:
$ composer install
Serve using the built-in PHP webserver:
$ php -S 127.0.0.1:8000
Open the page in your web browser by going to http://127.0.0.1:8000/public