Skip to content

Latest commit

 

History

History
97 lines (55 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

97 lines (55 loc) · 3.75 KB

How to Contribute

Raise an Issue

This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code style. Please report issues here Issues

Branch Policy

Sending Pull Request :

Go to the repository on GitHub at https://github.com/collegeconnect/CollegeConnect.

Click the “Fork” button at the top right.

You’ll now have your copy of the original College Connect repository in your GitHub account.

You may directly import using android studio or follow the steps below for cloning through terminal

Open a terminal/shell.

Type

$ git clone https://github.com/<your-username>/CollegeConnect

where 'username' is your username.

You’ll now have a local copy of your version of the original College Connect repository.

Change into that project directory (CollegeConnect):

$ cd CollegeConnect

Add a connection to the original owner’s repository.

$ git remote add upstream https://github.com/collegeconnect/CollegeConnect

To check this remote add set up:

$ git remote -v

Make changes to files.

git add and git commit those changes

git push them back to GitHub. These will go to your version of the repository.

Squashing your's changes

Before you make Pull Request, you should squash your commits into one.

Go into the directory for the project and type:

git checkout my_branch git reset --soft HEAD~Number git commit git push --force origin my_branch

where 'Number' is the number of commits to squash and 'my_branch 'is your branch name.

This will squash your commits into one single commit.

Now push them and Create A PR.

Now Create a PR (Pull Request)

Go to your version of the repository on GitHub.

Click the “New pull request” button at the top.

Note that CollegeConnect’s repository will be on the left and your repository will be on the right.

Click the green button “Create pull request”. Give a succinct and informative title, in the comment field give a short explanation of the changes and click the green button “Create pull request” again.

Pulling others’ changes

Before you make further changes to the repository, you should check that your version is up to date relative to CollegeConnect’s version.

You may directly pull changes using Android Studio or follow the terminal version below:

Go into the directory for the project and type:

$ git checkout development $ git pull upstream development --rebase

This will pull down and merge all of the changes that have been made in the original CollegeConnect repository.

Now push them back to your version of Github repository.

$ git push origin development

Important Note: Firebase Integration

Since the project is hosted on Firebase, we cannot share our google-serivces.json file due to secrurity purposes.

So, once you fork the project you'll have to link the app to your own firebase account before running the app. Click here to know how to add firebase to your project

For SHA1 fingerprint of debug.keystore navigate to keystore folder type the following in command prompt :
keytool -list -v -keystore debug.keystore -alias ccdebug -storepass ccdebug -keypass ccdebug

If you face any issues while linking to firebase you can ask your doubt at our Gitter Channel

Here is how your database should look after your upload some dummy data