Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

102 lines (74 loc) · 2.53 KB
Raw

How to contribute to this project

Here are 3 quick and painless ways to contribute to this project:

  • Add your name to the CONTRIBUTORS.md file
  • Add a profile page to the Profiles directory
  • Add a link to this project on your social media

Choose one or all 3, make a pull request for your work and wait for it to be merged!

Getting started

  • Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)
  • Clone your fork down to your local machine
git clone https://github.com/Abbhiishek/Webners.git
  • Create a branch
git checkout -b branch-name
  • Make your changes (choose from any task below)
  • Commit and push
git add .
git commit -m 'Commit message'
git push origin branch-name
  • Create a new pull request from your forked repository (Click the New Pull Request button located at the top of your repo)
  • Wait for your PR review and merge approval!
  • Star this repository if you had fun!

Complete all these tasks

1. Add your name

Add your name to the CONTRIBUTORS.md file using the below convention:

    {
        "id": 1,
        "type": "github",
        "username": "Abbhiishek",
        "place": "Kolkata , WestBengal",
        "bio": "Developer",
        "github": "https://github.com/Abbhiishek",
        "interests": [
            "Web Development",
            "App Development",
            "Machine Learning"
        ],
        "Projects": [
            {
                "id": 1,
                "name": "Webners",
                "description": "A website for developers",
                "link": ""
            }
        ],
        "Academics": "B.Tech in Computer Science and Engineering",
        "Skills": [
            "Python",
        ],

    }

2. Add Your Project in Contribution Folder

Create a Your_Project_Name folder to the Contribution directory. Use any combination of content and Markdown you'd like. Here is an example:

Include your project details in the README.md file in the Your_Project_Name folder in Contribution directory.

# Your Project Name
Your Project Name

### Description

Your Project Description

### Technologies Used

- HTML
- CSS
- JavaScript

### Link

[Your Project Name](GitHub Link)

Don't forget to include the comments as seen above. Feel free to include additional information about the language you choose in your comments too! Like a link to a helpful introduction or tutorial.

BONUS!

  • Checkout what other people have done and take inspiration ✨!