Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 3.13 KB
Raw

Welcome to the contributing section 🤝

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

1. READ CODE OF CONDUCT

Read the Code of Conduct before starting contributing.

2. Fork the repo

First of all fork the repo to your own GitHub account by clicking the Fork button on top-right corner. Still could not find 🙄,check the below image

fock

3. Clone the repo

Now it's time to copy this repo to own laptop/PC. To clone the repo you can write the below command in Git Bash

git clone <REPO_LINK_FROM_YOUR_ACCOUNT>

You can get the repo link from the Download section in the repo copied in your own account. Still having trouble🙄,see the below image

clone

4. Create a Branch specific to the Issue

git checkout -b branch-name

5. Set up remote repo

  • When you cloned your fork, that should have automatically set your fork as the "origin" remote. Use git remote -v to show your current remotes. You should see the URL of your fork (which you copied in step 3) next to the word "origin". If you don't see an "origin" remote, you can add it using below git command

    git remote add origin <REPO_LINK_FROM_YOUR_ACCOUNT>

6. Enough BoilerPlates, It's Flutter time now!!

  • Open cloned Project in your favourite IDE. It's time to decide your Playground

In order to contribute to the Application, have a look at some Issues.

7. Now it's time to save the work

  • Stage the changes you have made by firing the below command

    git add -A

  • Commit the changes

    git commit -m "Description of changes/your work"

  • Push the changes to your forked repo

    git push -u origin branch-name

8. Let's finish this

  • Go to your forked repo on GitHub website and refresh the page.

  • Click on pull-request and you will be redirected to another page where you will see something like below image

  • compare_pull

  • After that you have to write your GitHub username as the title of your pull-request and describe your work if you want and that's it!! Create a pull-request by clicking the button

    Mark the pull request as Ready for Review

    Also add the below 2 lines in the description. It is compulsory for sucessful submission.

    • I have read the Code Of Conduct.

    • I have followed all the steps of submission properly.

      pull_request