Skip to content

Latest commit

 

History

History
106 lines (60 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

106 lines (60 loc) · 3.66 KB
Raw

Contributing to WebDev-Source

Thank you for your interest in contributing to WebDev-Source! We welcome contributions from the community and appreciate your help in making our project better.

Signup/Register for Hacktoberfest

Sign up via the hacktoberfest account as a contributor at https://hacktoberfest.com/

Ways of Contributing

You can contribute to the repository in following ways:

  • Creating Issue
  • As a designer
  • Creating Pull Request for Issues.
  • All of the above

Creating Issue

Lets us know about the issue you have found in WebDev-Source by submitting issue.

We would like to request you to add the relevant title, description and any other media file that would be easier to understand the issue that you have submitted.

As a Designer

  • Create a PR under the folder "designs" that will be available at the root of this repository

  • Wait for your PR to get accepted

    Note: Setting up project, making changes and creating pull request is describe below.

Creating Pull Request for Issues

  • In the issues section of the WebDev-Source, you can see all the avaliable issue in the repository

  • Feel free to checkout all the issue, and request the author to assign you the issue(if not assigned).

  • After author have assigned you issues, make the necessary changes and open pull request as shown in below.

Fork, Clone, Change and Pull Request

Setting up Repository

  1. Click over the fork button of the repository.

  2. Click Create Fork button below down.

  3. Copy the ssh clone url.

  4. Cloning the forking repository using git clone command.

Adding Changes

  1. Create a new branch and switch it.

    git checkout -b <branch-name>
    Note:

    • branch_name must be relavent to the changes you are doing.*

    • If you are changing README`` files then branch_namecan bereadme`

  2. Make your changes and commit them.

    Once you have created your branch, make your changes and commit them. Remember to keep your commits atomic, that is, each commit should represent a single unit of change. Also, remember to write helpful commit messages, so that someone can understand what the commit does just from reading the message without having to read the diff.

    For examples,

    git add filename [filename ...]
git commit -m "descriptive message of what you did"

  3. Push up your changes.

    Push your changes to your fork. Do this by running

    git push origin <branch-name>

    Note: If the branch isn't present in the github rather present in your local machine then you can run git push -u origin <branch-name>

Submitting Pull Request

If you then go to your fork on GitHub, you should see a button to create a pull request from your branch.

Once doing this, you will be presented with a page. This page will show you the diff of the changes. Double check them to make sure you are making a pull request against the right branch.

  • Enter a descriptive title in the title field. This is very important, as it is what will show up in the pull request listing and in email notifications to the people in the repo. Pull requests with undescriptive titles are more likely to be passed by.