PHP SA 2018 Profiles

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.

View this project online

The master branch is regularly rolled out to production. It can be viewed online at http://www.phpsa2018profiles.co.za/

Instructions

Step One

Fork this Repo

Step Two

Extend the mostertb\PHPSA2018Profiles\Profiles\AbstractProfile class as mostertb\PHPSA2017Profiles\Profiles\<YourName>Profile

Step Three

Implement the following methods:

• getName()
• getBiography()
• getGitHubUsername()
• getProfileImageURL() (optional)
• getMaintainedProjects() (optional)
• getInvolvedProjects() (optional)
• getTwitterUsername() (optional)

If you get stuck, just look at someone else's Profile class for inspiration...

Step Four

Add your new Bio class to the construction of mostertb\PHPSA2018Profiles\Kernel :

     // In src/Kernel.php
    public function __construct()
    {
        $this->profiles = array(
            // ...
            new <YourName>Profile(),
            // ...
        );
    }

Added Gravatar Package. You can now specify your Gravatar by instantiating the GravatarApi Class, and using the getUrl method with your email address associated with Gravatar.

Step Four Point Five

Test your newly modified code with composer test. Resolve any issues the command raises.

Step Five

Submit Pull Request (How TO)

Step Six

Tweet your Pull Request @PHPSouthAfrica with the tag #PHPSA2018Profiles

This step is super important to the humor :)

Step Seven

PROFIT $$

Once your Pull Request is accepted, go say hi to Brad Mostert and he'll give you a GitHub sticker!

Where To Next

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

Running Locally

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

Switch to the public directory

  $ cd public

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/index.php