CONTRIBUTING.md

Welcome to the contributing section 🤝

Flutter is a hot topic and it's high time for you to find out that it's emerging technology can improve the Mobile App Development Process and reduce the Cost.

So let's come together and contribute something awesome to the Flutter community and also show the power and the height of feasibility for creating beautiful things🤩 and if you want to contribute. than you are at the right place, here are the steps how you can contribute to this 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

After a sucessful fork, you'll see a copy of this repo in your own account.

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

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. After that go to the lib->Contributions. In Contributions create a Dart File named (your_user_name). Great, you just created your playground, Now it's time for you to show your Creativity by designing and developing awesome custom Flutter Widgets.

  

• In that playground you can showcase your creativity, here is the simple file example

Visual Example:

After creating the playground, it's time to give reference to your playground from your HomePage

Here is how you can reference your playground.

Hurrah!!.., You are going preety well, and it's time for you to start designing your Custom Flutter Widget in your playground.

After you have finished designing a Custom Flutter Widget just copy the code of that particular widget, go to assets->files folder and create a txt file named (widget_name@your_user_name) and paste the code over there.

Visual Example:

Now, reference this file in your playgound, to display the code for your custom Flutter Widget

Still confused?...Here's what you can refer

Well, do not forget to add the (COPY CODE) button down there.

Boom, You have successfully added one Riddle🔥✨

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 origin branch-name

8. Let's finish this

• Go to your forked repo on GitHub website and refresh the page, you'll see something like the below image

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

  

• 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.

    

Woohoo!! Congratulations on making your open source contribution🎉🎉
Wait for some time to get your PR merged by our team