SSoC.md

Social Summer Of Code (SSoC)

This project is shortlisted for a three-months-long Open Source Program(Social Summer Of Code) Organized By Social in order to promote open source with new age technologies & help beginners to kickstart their open-source journey. Please get started by introducing yourself here.

Contribution Guide

If you're a participant of Social Summer Of Code(SSoC), please branch off from feature/web-app and raise a PR to feature/web-app. Currently this branch contains a client directory which contains a basic React boilerplate which can be developed further as a React app to generate Peerlist badges dynamically. In case, you have other frameworks in mind, please checkout a branch feature/web-app-<your framework> from develop and create your app within client directory. For building UI, take inspiration from Badges Generator and Shields.io.

Quick start

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/peerlist-readme-badge

3. Navigate to the project directory.

cd peerlist-readme-badge

4. Checkout to the feature branch

git checkout feature/web-app

5. Create a new branch.

git checkout -b <your_branch_name>

6. Navigate to client directory

cd client

7. Make changes in source code.

8. Stage your changes and commit

#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repo.

git push -u origin <your_branch_name>

10. Create a PR !

11. Congratulations! Sit and relax, you've made your contribution to Peerlist README Badge project.