TheZone/developer-portfolios
1
2
Fork 0
mirror of https://github.com/emmabostian/developer-portfolios.git synced 2025-04-21 05:38:01 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Add TLTR section to CONTRIBUTING file and instruction to the README as a

Browse Source 
reference.
This commit is contained in:
eclectic-coding 2019-12-28 18:37:21 -05:00
parent 8dbb4de65c
commit d9e0afa595
2 changed files with 109 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -1,5 +1,14 @@
# Contributor's Guide
# 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 thew 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)

2
README.md
View File

@ -2,7 +2,7 @@
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
[<img width="597" alt="Portfolio" src="https://user-images.githubusercontent.com/7671983/64871043-bab42880-d644-11e9-8e87-4a98d06339c9.png">](https://twitter.com/ASpittel/status/1171604728951779328)