Skip to content

Latest commit

 

History

History
90 lines (49 loc) · 2.95 KB

README.md

File metadata and controls

90 lines (49 loc) · 2.95 KB
Raw

Welcome to the Profile Showcase Repository! GitHub contributors

🎉

This repository is designed for beginners and students from West Bengal, who want to make their first open-source contribution during Hacktoberfest 2023 . By contributing to this repository, you can add your profile image and data, which will be displayed on the README page once your PR is approved.

Before everything

  • 📢 Register here for Hacktoberfest and make four pull requests (PRs) between October 1st-31st to qualify.

How to Contribute:

  • Fork this Repository: Click on the 'Fork' button at the top right corner of this repository. This will create a copy of this repository in your account.

  • Clone the Repository: Now, clone the forked repository to your machine. You can do this using the following command:

    git clone https://github.com/bongdevhq/profile-showcase.git`

  • Navigate to the Repository: Change your directory to the cloned repository:

    cd profile-showcase

  • Add your Profile Image:

    • Navigate to static/images/.
    • Add your profile image .Accepted files are png and jpg, should be Square and minimum size 544x544 pixels.
    • You can either drag and drop your image into this folder or use the following command:

    ``` cp /path-to-your-image.jpg static/images/`

  • Add your Profile Data:

    • Navigate to content/profiles/.
    • Create a new .md file with your name (e.g., firstname-lastname.md).

  • Add your profile data in the following format:

        `---
    name: 'Your Name'
    image: 'your-image-name.jpg'
    location: 'your home town distric in West Bengal' 
    bio: 'A short bio about yourself'
    institution: ' Your college details '
    organisation: ' your company name'
    ---`

  1. Commit and Push:

    git add . git commit -m "Added <your-name> profile" git push origin master

  2. Create a Pull Request (PR):

    • Go to your repository on GitHub.
    • Click on the 'Compare & pull request' button.
    • Review your changes and submit the pull request.

  3. Wait for PR Review: Once your PR is submitted, it will be reviewed. If everything looks good, your PR will be merged, and your profile will be displayed on the README page!

Note for Contributors:

  • This is an open-source project.
  • It's designed primarily for Hacktoberfest 2023 and for beginners to make their first contribution.
  • Please ensure your profile image and data are appropriate. Inappropriate content will not be merged.

Contributors:

Happy Hacking! 🚀