diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100755 index 0000000..adb674b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,200 @@ +# TLTR: Create a Pull Request +1. Fork this repository. +2. Clone the your new repository to your system. +3. Create a new branch (i.e. `add/your-name`). +4. Add your new site. Remember to add **alphabetically to the list.** +5. Commit changes and push the new branch. +6. Open and submit a PR. + +If you have never opened a PR and need direction, read more below. + +# Contributor's Guide +Feedback, bug reports, and pull requests are welcome. Feel free to ask for [help](https://github.com/emmawedekind/developer-portfolios/issues). + +Working on your first Pull Request? You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) + +This guide has been modified from [freeCodeCamp's Contributors Guide](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/CONTRIBUTING.md) + +## Forking the Project + +### Setting Up Your System + +1. Install [Git](https://git-scm.com/) or your favorite Git client. +2. (Optional) [Setup an SSH Key](https://help.github.com/articles/generating-an-ssh-key/) for GitHub. + +### Forking Developer Portfolios + +1. Go to the top level page of this [repository](https://github.com/emmawedekind/developer-portfolios) +2. Click the "Fork" Button in the upper right hand corner of the interface ([More Details Here](https://help.github.com/articles/fork-a-repo/)) +3. After the repository (repo) has been forked, you will be taken to your copy of the Developer Portfolios repo at + +### Cloning Your Fork + +1. Open a Terminal / Command Line / Bash Shell in your project's directory (_i.e.: `/yourprojectdirectory/`_) +2. Clone your fork of `Developer Portfolios` + +```shell +$ git clone https://github.com/yourUsername/developer-portfolios.git +``` + +**(make sure to replace `yourUsername` with your GitHub username)** + +This will download the entire `Developer Portfolios` repo to your project's directory. + +### Setup Your Upstream + +1. Change directory to the new directory (`cd ./developer-portfolios`) +2. Add a remote to the original `Developer Portfolios` repo: + +```shell +$ git remote add upstream https://github.com/emmawedekind/developer-portfolios.git +``` + +Congratulations, you now have a local copy of the `Developer Portfolios` repo! + +### Maintaining Your Fork + +Now that you have a copy of your fork, there is work you will need to do to keep it current. + +#### Rebasing from Upstream + +Do this prior to every time you create a branch for a PR: + +1. Make sure you are on the `master` branch + +```shell +$ git status +On branch master +Your branch is up to date with 'origin/master'. +``` + +If your aren't on `master`, resolve outstanding files / commits and checkout the `master` branch + +```shell +$ git checkout master +``` + +2. Do a pull with rebase against `master` + +```shell +$ git pull --rebase upstream master +``` + +This will pull down all of the changes to the official master branch, without making an additional commits in your local repo. + +3. Merge remote changes to your local master fork: + +```shell +$ git merge upstream/master +``` + +### Create a Branch + +Before you start working, you will need to create a separate branch specific to the issue / feature you're working on. You will push your work to this branch. + +#### Naming Your Branch + +There several strategies for naming branches. + +You could name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where you fix something specific to email login. + +We'd recommend to name it something that relevant to your new site (i.e. `add/your-name` + +#### Adding Your Branch + +To create a branch on your local machine (and switch to this branch): + +```shell +$ git checkout -b [add/your-name] +``` + +and to push to GitHub: + +```shell +$ git push origin [add/your-name] +``` + +**If you need more help with branching, take a look at [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches).** + +### Creating a Pull Request + +#### What is a Pull Request? + +A pull request (PR) is a method of submitting your new site to the `Developer Portfolios` (or any repo, for that matter). You will make changes to copies of the files in a personal fork, then apply to have them accepted by the original repo. + +#### Need Help? + +Feel free to ask for [help](https://github.com/emmawedekind/developer-portfolios/issues), we are here to help. + +#### Important: ALWAYS EDIT ON A BRANCH + +Take away only one thing from this document: Never, **EVER** make edits to the `staging` branch. ALWAYS make a new branch BEFORE you edit files. This is critical, because if your PR is not accepted, your copy of staging will be forever sullied and the only way to fix it is to delete your fork and re-fork. + +#### Methods + +There are two methods of creating a pull request for 'Developer Portfolios': + +* Editing files on a local clone (recommended) +* Editing files via the GitHub Interface + +##### Method 1: Editing via your Local Fork _(Recommended)_ + +This is the recommended method. Read about [How to Setup and Maintain a Local Instance](#maintaining-your-fork). + +1. Perform the maintenance step of rebasing `master`. +2. Ensure you are on the `master` branch using `git status`: + + $ git status + On branch master + Your branch is up-to-date with 'origin/master'. + + nothing to commit, working directory clean + +3. If you are not on `master` or your working directory is not clean, resolve any outstanding files/commits and checkout `git checkout master` + +4. Create a branch off of `develop` with git: `git checkout -b add/your-name` + +5. Edit your file(s) locally with the editor of your choice. + +6. Check your `git status` to see unstaged files. + +7. Add your edited files: `git add path/to/filename.ext` You can also do: `git add .` to add all unstaged files. Take care, though, because you can accidentally add files you don't want added. Review your `git status` first. + +8. Make sure your new site is added **alphabetically** to the existing list. + +9. Commit your edits. `git commit -m "your-commit-message"` + +Please make sure to write a commit message that summarizes the changes. If you find yourself in the need to use `and` it might be better to do two separate commits. + +See [Useful Tips for writing better Git commit messages](https://code.likeagirl.io/useful-tips-for-writing-better-git-commit-messages-808770609503) for inspiration. + +As a note, use the presrnt tense for your commit messages (i.e. `Add` instead of `Added`). + +10. If you would want to add/remove changes to previous commit, add the files as in Step 5 earlier, and use `git commit --amend` or `git commit --amend --no-edit` (for keeping the same commit message). + +11. Push your commits to your GitHub Fork: `git push origin add/your-name` + +12. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page. + +13. By default, all pull requests should be against the `Developer Portfolios` main repo, `master` branch. + **Make sure that your Base Fork is set to developer-portfolios/master when raising a Pull Request.** + +14. Submit a pull request from your branch to `Developer Portfolios` `master` branch. + +15. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicate what is being fixed. + + * **Do not add the issue number in the PR title or commit message.** + + * Examples: `Add site NAME` + +### Next Steps + +#### If your PR is accepted + +Once your PR is accepted, you may delete the branch you created to submit it. This keeps your working fork clean. + +You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: `git branch -D branch/to-delete-name` + +#### If your PR comes back + +Don't despair! You are probably being asked to make a formatting change. If you have a local copy of the repo, you can make the requested changes, commit them and push them to your fork. diff --git a/README.md b/README.md index 10e3827..3b395a3 100755 --- a/README.md +++ b/README.md @@ -2,162 +2,230 @@ A list of developer portfolios for your inspiration -Have you built a portfolio? Are you proud of it?! Open a PR to this repo and let's showcase your work! +Have you built a portfolio? Are you proud of it?! Open a [PR](./CONTRIBUTING.md) to this repo and let's showcase your work! Refer to the [CONTRIBUTING](./CONTRIBUTING.md) file for direction. This repo was inspired by [Ali Spittel's](https://twitter.com/ASpittel) tweet [Portfolio](https://twitter.com/ASpittel/status/1171604728951779328) Hopefully this repo can serve as a source of inspiration for your portfolio! +--- - - - -* [Abdelouahed Medjoudja](https://geekabdelouahed.github.io/flutter-web-portfolio) +## A +* [Abdelouahed Medjoudja](https://geekabdelouahed.github.io/flutter-web-portfolio) * [Abdul Rauf](https://armujahid.me) * [Adam Conrad](http://conradadam.com) -* [Agney Menon](https://agney.dev) +* [Agney Menon](https://agney.dev) * [Ahmad Awais](https://ahmadawais.com/) -* [Alejandro Sobko](http://alejandrosobko.com) -* [Alex Goff](http://alex-goff.com) +* [Alejandro Sobko](http://alejandrosobko.com) +* [Alex Goff](http://alex-goff.com) * [Alexander Schmidt](https://alexanderschmidt.info/) -* [Alexey Golub](http://tyrrrz.me) -* [Ali Spittel](http://alispit.tel) -* [Aman Mittal](http://amanhimself.dev) -* [Andrew Woods](https://andrewwoods.net) -* [Andy Bell](https://andy-bell.design/) -* [Anshuman Verma](https://anshumanv.dev/) +* [Alexey Golub](http://tyrrrz.me) +* [Ali Spittel](http://alispit.tel) +* [Aman Mittal](http://amanhimself.dev) +* [Andrew Woods](https://andrewwoods.net) +* [Andy Bell](https://andy-bell.design/) +* [Anil Khatri](https://imkaka.github.io) +* [Anshuman Verma](https://anshumanv.dev/) +* [Antoni Kepinski](https://kepinski.me) * [Arjun Ganesan](https://arjun-g.com) -* [Ashlee Boyer](http://ashleemboyer.dev) -* [Bankole Ahmed](http://bankoleahmed.netlify.com) -* [Becca Bailey](http://Becca.is) -* [Bekah Hawrot Weigel](http://bekahhw.github.io) -* [Ben Greenberg](http://bengreenberg.dev) -* [Benjamin Lannon](https://lannonbr.com) -* [Bhavani Ravi](http://bhavaniravi.com) +* [Aromal Anil](https://aromalanil.me) +* [Ashlee Boyer](http://ashleemboyer.dev) + +## B +* [Bankole Ahmed](http://bankoleahmed.netlify.com) +* [Becca Bailey](http://Becca.is) +* [Bekah Hawrot Weigel](http://bekahhw.github.io) +* [Benjamin Lannon](https://lannonbr.com) +* [Bhavani Ravi](http://bhavaniravi.com) * [Bob Matyas](https://www.bobmatyas.com) -* [Bolaji Ayodeji](https://www.bolajiayodeji.com/about/) -* [Bouwe Westerdijk](https://bouwe.io) -* [Brad Garropy](https://bradgarropy.com) -* [Brianna Roby](http://brianna-roby.com) -* [Brittany Chiang](brittanychiang.com) -* [Brooks Cody](http://brookscody.com/) +* [Bouwe Westerdijk](https://bouwe.io) +* [Brad Garropy](https://bradgarropy.com) +* [Brianna Roby](http://brianna-roby.com) +* [Brittany Chiang](https://brittanychiang.com) + +## C * [Cade Kynaston](https://cade.codes) * [Caitlyn Greffly](https://caitlyngreffly.com/) -* [Cecelia Martinez](http://ceceliacreates.com) +* [Cecelia Martinez](http://ceceliacreates.com) * [Charles C. Pustejovsky III](https://cpustejovsky.com/) * [Chetan Padia](https://chetbox.com) * [Chicago IT Systems](https://www.chicagoitsystems.com/) -* [Chris Poole](https://chrispoole.com) -* [Cole Emeruche](https://coleruche.com/works/) -* [Conlin Durbin](https://wuz.fyi) -* [Dann Conn](https://t.co/3WsyCciW3H?amp=1) -* [Danstan Onyango](https://zemuldo.com/) -* [Dick Wyn Yong](https://dickwyn.xyz) +* [Chris Otto](https://chrisotto.dev/) +* [Chris Poole](https://chrispoole.com) +* [Cole Emeruche](https://coleruche.com/works/) +* [Colin Lord](https://colinlord.com/) +* [Conlin Durbin](https://wuz.fyi) + +## D +* [Damian Markowski](http://damianmarkowski.pl) +* [Danstan Onyango](https://zemuldo.com/) +* [Dave Hill](https://davehill.dev/) +* [Dick Wyn Yong](https://dickwyn.xyz) * [Dillion Megida](http://dillionmegida.com/about) -* [Dimitri Pashutskii](https://dpashutskii.com/) +* [Dimitri Pashutskii](https://dpashutskii.com/) * [Drew Bredvick](https://drewb.tech/about) -* [EchoEye](https://echoeyecodes.com) -* [Efrén Martínez Rodríguez](https://efren.xyz) -* [Emmanuel ADEKPLOVI](https://homescriptone.com) -* [Enea Xharja](https://eneaxharja.com) -* [Ezekiel Ekunola](https://ezekielekunola.com) -* [Farai Gandiya](http://fgandiya.me) -* [Felix Leupold](https://xiel.dev) -* [Fidalgo Pedro](http://fidalgo.dev) -* [Flavia Medici](https://t.co/iQK1Hbx8xD?amp=1) + +## E +* [Efrén Martínez Rodríguez](https://efrenmartinez.github.io) +* [Emmanuel ADEKPLOVI](https://homescriptone.com) +* [Enea Xharja](https://eneaxharja.com) +* [Ezekiel Ekunola](https://ezekielekunola.com) + +## F +* [Felix Leupold](https://xiel.dev) +* [Fidalgo Pedro](http://fidalgo.dev) +* [Flavia Medici](https://t.co/iQK1Hbx8xD?amp=1) * [Flavia Nunes](https://fluvixx.dev/) -* [Franklin Castellanos](https://onecastell.github.io) -* [Gabriela Radu](http://gabrielaradu.me) -* [Gabriele Corti](https://borntofrappe.github.io/) -* [Georgi Yanev](https://gyanev.com) -* [Gherciu Gheorghe](https://gherciu.github.io/portfolio/) +* [Franklin Castellanos](https://onecastell.github.io) + +## G +* [Gabriela Radu](http://gabrielaradu.me) +* [Gabriele Corti](https://borntofrappe.github.io/) +* [Georgi Yanev](https://gyanev.com) +* [Gherciu Gheorghe](https://gherciu.github.io/portfolio/) * [Gianluca Fiore](http://gianlucafiore.it) -* [Hassan Murtaza](https://hassanmurtaza.com) -* [Herman Starikov](http://starikov.dev) -* [Isitha Subasinghe](https://isub.dev) -* [Jacob Herrington](http://jh.codes) -* [Jacobo Martinez](https://cobimr.xyz) -* [James Turner](http://turnerj.com) -* [Jamie Hammond](https://jamiehammond.dev/) -* [Jane Manchun Wong](http://wongmjane.com) -* [Janessa Tran](http://janessatran.github.io) -* [Jens van Wijhe](https://jens.ai) -* [Jeremy Grifski](https://jeremygrifski.com/) -* [Jerry Hirsch](https://jerryhirsch.com/) + +## H +* [Hassan Murtaza](https://hassanmurtaza.com) +* [Herman Starikov](http://starikov.dev) +* [Hungry Bear Studio](https://www.hungrybearstudio.com/) + +## I +* [Isitha Subasinghe](https://isub.dev) +* [Ismail Ghallou aka Smakosh](https://smakosh.com) + +## J +* [Jacob Herper](https://herper.io) +* [Jacob Herrington](http://jh.codes) +* [James Turner](http://turnerj.com) +* [Jamie Hammond](https://jamiehammond.dev/) +* [Jane Manchun Wong](http://wongmjane.com) +* [Janessa Tran](http://janessatran.github.io) +* [Jens van Wijhe](https://jens.ai) +* [Jeremy Grifski](https://jeremygrifski.com/) +* [Jerry Hirsch](https://jerryhirsch.com/) * [Jibin Thomas](http://jibin.tech) * [Johnson Ogwuru](https://johnsonogwuru.tech/) -* [Josef Aidt](https://josefaidt.dev) -* [Joseph Friedman](http://DecentGradient.com) -* [Kaleigh Scruggs](http://kaleighscruggs.com) -* [Kamran Hamid](https://mkamranhamid.netlify.com) +* [Jordan Liu](https://jordanxliu.com) +* [Josef Aidt](https://josefaidt.dev) +* [Joseph Friedman](http://DecentGradient.com) + + +## K +* [Kaleigh Scruggs](http://kaleighscruggs.com) +* [Kamran Hamid](https://mkamranhamid.netlify.com) * [Kapil Gorve](http://jskap.com) * [Karen Fletcher](https://knpfletcher.dev) * [Karthik Menon](https://karthikmenon.me/) +* [Kenny Tran Co](https://www.kennytran.co) +* [Kouceyla Hadji](https://www.behance.net/kossa) +* [Kumar Abhirup](http://kumar.now.sh) * [Kyle Harrison](http://kyle.teamharrison.ca) -* [Kyle Shook](http://Kyleshook.com) -* [Laurie Barth](http://laurieontech.dev) -* [Lee Warrick](http://leewarrick.com) +* [Kyle Shook](http://Kyleshook.com) + +## L +* [Laurie Barth](http://laurieontech.dev) +* [Lee Warrick](http://leewarrick.com) * [Lisa Blunt](https://lisablunt.github.io) -* [Lisa Savoie](http://lscodes.com) -* [Liz Lam](https://lizlam.github.io/) +* [Lisa Savoie](http://lscodes.com) +* [Liz Lam](https://lizlam.github.io/) * [Luca Lischetti](https://sirlisko.com) -* [Louay Hamada](https://louayhamada.com) +* [Louay Hamada](https://louayhamada.com) * [Luisa Rojas García](https://luisarojas.com) -* [Lwin Moe Hein](http://lwinmoehein.me) -* [Marc Backes](http://marc.dev) +* [Lwin Moe Hein](http://lwinmoehein.me) + +## M +* [Marc Backes](http://marc.dev) * [Marcos Aguayo](https://marcosaguayo.com) * [Margaret M Barringer](http://webwabisabi.com) -* [Mario Kandut](https://www.mariokandut.com) -* [Marissa Phul](http://mphul.codes/) -* [Mark Shaffer](http://codemelted.com) -* [Marouane Rassili](https://mrassili.com) -* [Mary Kathryn](http://marykrzesicki.me) -* [Maya Shavin](https://www.mayashavin.com/) +* [Mario Kandut](https://www.mariokandut.com) +* [Marissa Phul](http://mphul.codes/) +* [Marouane Rassili](https://mrassili.com) +* [Mary Kathryn](http://marykrzesicki.me) +* [Matteo Lobello](https://matteolobello.it) +* [Maya Shavin](https://www.mayashavin.com/) * [Md Nabil Ahsan](https://www.mdnabilahsan.com/) * [Michael Johnston](https://michaeljamie.com/) -* [Michelle Brenner](http://MichelleBrenner.com) -* [Mike Perry Y Attara](https://mikeattara.com) +* [Michelle Brenner](http://MichelleBrenner.com) +* [Mike Perry Y Attara](https://mikeattara.com) * [Mimi Kim](https://seeyouspacecow.com) +* [Mitul Savani](http://mitulsavani.com) +* [Mohamed Abdel Nasser](https://www.mohdabdelnasser.live/) * [Moritz Kornher](https://moritzkornher.de/) +* [Mouad ZIANI](https://mouadziani.github.io/) * [Muhammad](http://muhammadraza.me) * [Muhammad Muhaddis](https://muhaddis.info) -* [Muntadhar Haydar](https://muntadhar.net) -* [Nico van Zyl](https://nicovanzyl.com) -* [Nicolo Rebughini](https://nirebu.com/) -* [Nikush Dalia](https://nikushx.com) -* [Opeyemi Obembe](http://obem.be/opeyemi) +* [Muntadhar Haydar](https://muntadhar.net) + +## N +* [Nico van Zyl](https://nicovanzyl.com) +* [Nicolo Rebughini](https://nirebu.com/) +* [Nikush Dalia](https://nikushx.com) + +## O +* [Olaolu Olawuyi](https://olaolu.dev) +* [Omar Gastón Chalas](https://ogaston.com/en/knowme) +* [Opeyemi Obembe](http://obem.be/opeyemi) + +## P +* [Pandiyan Murugan](https://pandiyancool.github.io/pandiyan.cool/) * [Patricia Aas](https://patricia.no/) * [Patrick Hyatt](https://www.patrickhyatt.com/) * [Patrick Lehmann](https://patlehmann1.github.io/react_portfolio/) -* [Patrick Reid](http://iamreliq.com) -* [Praveen Saini](https://praveen-me.github.io) -* [Rafael Solis Melo](https://rsmelo92.github.io/portfolio/) +* [Patrick Reid](http://iamreliq.com) +* [Praveen Kumar Purushothaman](https://praveen.science/) +* [Praveen Saini](https://praveen-me.github.io) +* [Priyadharshini Rajaram](https://priya.ws/) + +## R +* [Rafael Solis Melo](https://rsmelo92.github.io/portfolio/) * [Rahul Sawant](http://raalzz.com) +* [Rajan Bhattarai](https://cdrrazan.com) +* [Rajekevin](http://rajekevin.fr) +* [Rick Hanlon](https://rickhanlon.codes) * [Rimenes Ribeiro](https://rimenesribeiro.com) * [Riley J. Shaw](https://rileyjshaw.com) -* [Roland L. Taylor](http://rolandixor.pro) -* [Ropo John Olatujoye](http://simplycrownclothing.herokuapp.com) -* [Ryan Burgess](http://ryanburgess.com) -* [Ryan MacLean](http://ryanmaclean.com) -* [Sagar Giri](https://girisagar46.github.io/) -* [Santosh Yadav](http://santoshyadav.dev) -* [Saurabh Daware](https://www.saurabhdaware.in/) -* [Shannon Crabill](http://shannoncrabill.com) +* [Roland L. Taylor](http://rolandixor.pro) +* [Ropo John Olatujoye](http://simplycrownclothing.herokuapp.com) +* [Ryan Burgess](http://ryanburgess.com) +* [Ryan MacLean](http://ryanmaclean.com) + +## S +* [Sagar Giri](https://girisagar46.github.io/) +* [Santosh Yadav](http://santoshyadav.dev) +* [Saurabh Daware](https://www.saurabhdaware.in/) +* [Scott Spence](https://scottspence.me) +* [Shannon Crabill](http://shannoncrabill.com) * [Simon Gilbert](https://www.simongilbert.net) -* [Soham Mondal](https://sohammondal.com) -* [Sourav Dutta](http://i-am-souravdutta.firebaseapp.com) -* [Sree Godavarthi](http://sreegodavarthi.github.io) +* [Soham Mondal](https://sohammondal.com) +* [Sourav Dutta](http://i-am-souravdutta.firebaseapp.com) +* [Sree Godavarthi](http://sreegodavarthi.github.io) * [Stefan Bohacek](https://fourtonfish.com/) -* [Syeda Aimen Batool](http://aimen.dev) -* [Tejas Kumar](http://tej.as) +* [Steve Baros](https://steveebaros.me) +* [Syeda Aimen Batool](http://aimen.dev) + +## T +* [Tejas Kumar](http://tej.as) * [Thea Mushambadze](https://highflyer910.github.io/) -* [Tom Sherman](https://tom-sherman.com) -* [Vaibhav Singh](http://vaibhavsingh97.com) -* [Varun Dey](https://varundey.me) -* [Vicente G. Reyes](https://highcenburg.herokuapp.com/) -* [Victor Aremu](http://bit.ly/victoraremu) -* [Vincent Milum Jr](http://darkain.com) +* [Tom Sherman](https://tom-sherman.com) + +## V +* [Vaibhav Singh](http://vaibhavsingh97.com) +* [Vansh Bhardwaj](http://iamvansh.pythonanywhere.com/) +* [Varun Dey](https://varundey.me) +* [Vicente G. Reyes](https://highcenburg.herokuapp.com/) +* [Victor Aremu](http://bit.ly/victoraremu) +* [Vincent Milum Jr](http://darkain.com) * [Vishwasa Navada K](https://vishwas.tech) -* [Yechiel Kalmenson](https://yechiel.me) +* [Vidushan Chooriyakumaran](https://vidu.sh/an) + +## W +* [Wajahat Ali Abid](https://wajahataliabid.github.io/) + +## Y +* [Yechiel Kalmenson](https://yechiel.me) + +## Z +* [Ziyad](https://ziyadsk.github.io/Portfolio/) * [Zunaid Aslam](https://zunaidaslam.com)