Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 3.84 KB
Raw

Contribution Guidelines

This documentation contains a set of guidelines to help you during the contribution process of this project.

Step 1. Fork this repository

Visit the repository on Github and scroll to the readme section, you'll see a pencil icon on the right, click it to fork the project. This will create a copy in your account.

fork-project

Step 2. Create a new table

The portfolio examples are enclosed between two comments:

  • <! -- ⭐ PORTFOLIO START ⭐ -- >
  • <! -- ⭐ PORTFOLIO END ⭐ -- >

portfolio-comments.png

To add a portfolio, you can either create a new table or copy an already existing table at the bottom of the list and edit it, your choice.

Warning

DISCLAIMER: ⚠️Portfolios should be added at bottom of the list.

Step 3. Add Portfolio Details

In the new table, start each column with a | symbol followed by the column content:

⚡ Author Name

Start a new line below the latest portfolio and add the author or creator of the portfolio website, like so: | Jemima Abu

author-name.png

⚡Screenshot

Take a screenshot of the homepage of the portfolio website, drag it and drop it into the screenshot column. Please before adding the screenshot, use services like tinypng.com or compressor.io to optimize the image sizes.

⚡Live URL

Add the live link to the portfolio website. PS: Omit the https:// protocol on the link text. Example:

[victoreke.com](https://victoreke.com)

⚡Repo

If the portfolio is available on GitHub, post the repository link, if not, just write "None"

[GitHub](https://github.com/jemimaabu/portfolio)

repository.png

⚡Tech Stack

The next and final thing to add is the tech stack of the portfolio website. You can use wappalyzer, or any other service to detect the stack.

E.g HTML, CSS, JavaScript

Step 4. Preview and create a PR

Now we are done adding all the portfolio information, preview the portfolio added and make sure it corresponds with the table, then raise a pull request.

Need more help? 🤔

If you need any adittional guide or help with any issues, feel free to contact me on twitter and I'll answer ASAP. That's a promise 🤝🏽😊

Sponsor

Wanna buy me a coffee, I'll sincerely appreciate it. Here's the link below.

bmc-button
I hope you have a lot of fun while contributing to this project, if you drew inspiration from any portfolio on this repo, consider starring this project or sending the creator a thank you message. I sincerely hope you build an amazing portfolio website that will blow the recruiter or visitor's mind. Goodluck. ⚡

portfolio ideas comic

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by the Code Of Conduct.