Skip to content

Latest commit

 

History

History
192 lines (104 loc) · 9.85 KB

README.md

File metadata and controls

192 lines (104 loc) · 9.85 KB
Raw

Welcome to 'Androiders Buddy'! 😄

We welcome you to our project where you can contribute to the project by developing dedicated apps for a particular dedicated topic which will make you acquainted with that topic thoroughly .

Program:

PClub Summer Of Code


PSoC started June 2020 - ended August 2020


The PSoC started on June 26th 2020 and ended on August 26th 2020. It was a 2 month long open source event. The issues and pull requests created during this period are of PSoC. The project is open for contribution and will accept changes and updates even after the official coding period of PSoC gets over. Therefore the issues and the pulll requests created after this period are all valid and accepted.

Note

  • We will be using Android Studio as our tech-stack software.
  • The language which we will be using will be Java.

The Project 📂

The project is like your very own repository where you can add android studio app projects for the below mentioned topics. The project is divided into two parts -

  1. UI, the XML part/Widgets

  2. Java coding

Further we will have topics which will make you connect your XML with the Java code. We will be covering almost all the concepts of Android development which a newbie must learn. These topics will act as the building-blocks By customizing and assembling these blocks, you will then be able to create your own app with all the necessary elements in it.

We will then be reviewing and adding your project apps under the respective topic folder.

How to Contribute? 🤔

  • First of all you've to comment down on the issue which you want to do. We will then assignee you that issue/project. Then you have to create an app in which you implement that particular Android topic. Don't just randomly send in your PR we need to follow some basic rules of open source. Although you can create some relevant issues of some good Android topics on which you would like to work or would want to see in the repository ( don't forget to follow the issue template ).

  • Secondly then you don't have to upload your entire app which you have created earlier, you have to create a folder in which you add the .java file, the .XML file and the screenshot of the visible working output of the app and then commit and push this folder to the 'UI XML' or 'Java' folder of the repository depending on the topic. Name this folder same as the topic name. After doing so create a PR and follow the PR template.

The UI/Widgets related topics:

The UI/Widgets related topics:

The java coding topics:

The java coding topics:

Contribution best practices ✅

For First time Contributors

Kindly read the CONTRIBUTE.md file first to know some basic git commands and the proper way to create issue and send pull requests.

Branch Policy

To make things easy for all of us we are as of now having only one branch that is the master branch hence you need to make pull request to the master branch only.

Code Practices

'With good code practices come efficiency' hence we would like you to follow some code practices -

  • Try making single commit per pull request,

  • Try using decent commit messages by following the COMMITSTYLE convention.

  • If the PR is related to any front end UI, please attach relevant screenshots in the pull request description.

  • Follow uniform design practices. The design language must be consistent throughout the app.

Please help us follow the best practices to make it easy for the reviewer as well as the contributor.

Join Now 📧

The best and the only way to join the project is by opening an issue or solving an existing issue by sending a pull request.

If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

Contact Us

If you have any doubts regarding the projects or need help kindly write to us or join on the following links.

Guidelines 👉

  • Before you join the development, please run and test the code developed by you on your local machine by keeping in all the checks and compiling it properly. Check the code completely and then create a pull request.

  • We want that all the coders must follow some decency while working on this project that a proper online code of conduct must be followed. The only restriction we impose is that your action or words must not hurt others. At the end of the day we all are forging ahead to accomplish a unanimous goal that is to help contribute to open source.

Future 💻

In the future we are planning to launch this project by deploying this project into an app and website as well so that it accessible to a major audience.