CONTRIBUTING.md

How to contribute (Short Version)

Clone the project and do development on a feature branch, and then create a pull-request.

How to contribute (Comprehensive Version)

Clone/fork repo and navigate to folder

Clone: git clone https://github.com/jangerhard/react-github-showcase.git
Fork: See Github Guide
cd react-github-showcase

Create a development branch for your feature/contribution

git branch feature-[SOME-FEATURE]

Do development!

Set up NPM Link

npm link

Start it up!

npm start

Use component in a new project to see changes (Won't be necessary after jest-testing is in place)

Create a simple React project using a starter pack of your choice.

Set up npm link within your react project

cd your-react-project
npm link react-github-showcase

Import into project

import GithubShowcase from 'react-github-showcase';

<div>
    <GithubShowcase
        username={ANY_VALID_USERNAME}
        api_key={API_KEY}/>
</div>

Remember to not submit your Api Key to Git. Use Environment Variables

Once you run your react project you should see the Github Showcase!