Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

72 lines (42 loc) · 3.35 KB
Raw

Back

Contributors' Guide

💪👍 First off, thanks for taking the time to contribute, you are amazing! 👍💪

This is a growing list of resources for learning and improving as a developer and/or designer and we want to make contributing as easy and transparent as possible, whether it is:

Prerequisites

  • Git or any equivalent Version Control System
  • Code Editor (VsCode, Sublime Text, Atom e.t.c)
  • Little command line knowledge
  • The zeal to share learning resources with others 😊

Getting Started

  1. If you are new to Git and Github, it is advisable you go through GitHub For Beginners and Basic Git WorkFlow

  2. New to open source contributions? we've got you covered: Contributing to Github

  3. Fork this Repository here

  4. Clone the forked Repository
    git clone https://github.com/Your-GitHub-Username/resources.git

  5. Open the cloned directory in your Code Editor.

  6. Add your name to the Contributors List.

Adding Learning Resources

  1. We have created a list of markdown (.md) files for different categories of learning resources. Find the category/categories related to the resources you want to add in the root directory

  2. Check if the resources you want to add is already included. If not, then you can proceed!

  3. Add your resources at the end, follow the pattern of the already existing resources. It should include:

    • Name of the resources (as a link to the resource page)
    • A brief description of its content and other related information.

    Here are some examples:
    - [JavaScript30](https://javascript30.com/): A 30-day coding challenge in which you will build 30 things using vanilla JavaScript

    - [mmtuts](https://www.youtube.com/user/TheCharmefis/featured): **_mmtuts_** (a.k.a MultiMedia Tutorials) aims to provide tutorials spanning the gamut of programming, video editing/production, animation, and graphic design.

  4. If you want to create a new category for your resources, kindly open an issue to let the project maintainers know of this new category before creating one.

  5. Open a pull request, with a short descriptive branch name and commit messages

Submitting a Fix

If you ever noticed a bug or anything worth fixing, feel free to open an issue with enough details of the bug, steps to replicate it and screenshots if possible.

Proposing New Features

Have some new exciting features you'd like to add? Let our maintainers know first. Open an issue describing this new feature and why you think it should be included!

Helpful Resources

Licence

MIT