Skip to content

Latest commit

 

History

History
98 lines (52 loc) · 2.78 KB

README.md

File metadata and controls

98 lines (52 loc) · 2.78 KB
Raw

Connectify

This project is a simple chat application UI, which is a foundation for a community where people can connect themselves and have fun.

This is a prototype, in which any of you can contribute and learn how to make contributions.

Author

Tech Stack Used:

Client: Flutter

Language : Dart

Pre-requisites

First thing you would likely to have is Flutter installed in your 'machine'.

If not so, after going back to hostel/home. Make a try installing.

For the first time, installation is really a big task. if got stuck, then reach out to the authors.

Installation

  1. Create a flutter project
flutter create app-name
  1. Clone the repo
git clone https://github.com/ossrndc/connectify.git
  1. Install pub modules
pub get

Hurray!! Now you are all set to make contributions. All the best !!

Contributing

Contributions are always welcome!

Contributions are what make the open source community such an amazing place to be learn, inspire, and create.

The event COMMIT '24 would let you explore all the sides of open source.

Not only you would learn to make your code public, you would also explore the industry level projects.

  • If you have suggestions for adding or removing features, feel free to open an issue to discuss it, or directly create a pull request.

  • Create individual PR for each suggestion.

Creating A Pull Request:

IMPORTANT : You have to generate separate pull requests of each issue along with screenshot ,video of the changes you made .

  1. Fork the Project:

    As explained by us during event, by forking a project, you simply make a copy of the project in your github repo.

    why it is necessary? Because it allows us to make changes which ever you want. Moreover, it allows you to generate PRs, to the original repo from your repo.

    Still any abouts? Ask the volunteers or authors !! We are here to help you.

  2. Create your Feature Branch (git checkout -b feat/AmazingFeature) or Bug Fix Feature (git checkout -b fix/BugName).

  3. After cloning the project, run the following command, git remote add upstream https://github.com/ossrndc/connectify.git

  4. Commit your Changes (git commit -m 'Add some AmazingFeature' or git commit -m 'Fixes #issueNumber).

  5. Push to the Branch (git push origin feature/AmazingFeature).

  6. Open a Pull Request to main through your github account.

Before any contribution,

  1. Sync the code : git pull upstream main
  2. Sync the code with your remote : git push origin main
  3. Switch to new branch : git checkout -b feat/new_feature
  4. git add . and git commit -m "What you did in this commit"
  5. git push origin

Now, create a PR :)