Project contribution

[SarraLKSC]

Info

The main reason behind the repo is to serve as a library of open source project contributed that can be accessed and used by the community.

Share a project that can be useful for communities (for individuals, groups, organization ...etc) on any topic or technology (it can be a jupyter notebook explaining and demoing some concepts about data visualization, a basic landing page for organizations/brand/hackathon, a chat app, a text game, ... etc)

How

• put your project inside the _/projects_ folder.
• name your project folder, e.g: my magical cookie maker
• Have your own README.md file inside your own project file where you explain what is it for, how to setup/build the project & its requirements (if required) ...etc
• Update the parent projects/README.md file with the path to your project folder (instead of url)

HacktoberFest_2021 
    │
    ├── projects                    # main parent projects folder
    │    ├── Magical cookie             # your contributed project
    │    │     ├── project_files            # your contributed project files/folders ... 
    │    │     └── README               # your project README.md
    │    │  
    │    ├── Another project            # your contributed project
    │    │     ├── project_files            # your contributed project files/folders ... 
    │    │     └── README.md            # your project README.md
    │    │
    │    └── README.md              # main README file
    │
    ├── CONTRIBUTING.md             # contribution guidelines
    └── README.md                   # main README file

Pull Requests

• Make sure to give your PR a clear title (e.g: contributing a hackathon website project)
• Please explain what method you used and how you built the feature (briefly).
• Make sure to include some screenshots for the results in your Pull Request submission (you can put them in a markdown table if you're doing a comparison if you wish).

Notes:

• Do not upload projects in compressed format (rar, zip ...etc), the source should be accessible.
• ALWAYS refer to CONTRIBUTING.md guidelines

[vickywane]

@SarraLKSC I added something here.