Contributing

Why?

This makes sure that the development process is structured and which helps improve the quality of the code written.

How?

In order to do the set above goal, we need to restrict direct contributions to the codebase. This means developers should not be pushing major or medium size code changes. It is of course acceptable if a developer decides to manually push a small change such as renaming a button or variable. Otherwise, a developer should follow these set of instructions

Steps

1. If you haven't already, clone the repository on Android Studios using the https://github.com/KashmirWorld/GeoSnapApp.git as the Repository URL
2. Make sure to PULL the sourcecode from the repository every time you open up Android Studios
3. Checkout to a new branch at the bottom right if you haven't already
4. Edit the code that you need to edit to implement the feature or fix in mind
5. Commit the code with a GOOD commit message
6. Once you've finished the source code, push it to the github page
7. Open up the github page and create a Pull-Request from your newly added branch, create a good Pull Request message and tag someone to come and take a look at it
8. Wait for it either to get merged or for feedback

Best Practices / Guideline

There are a lot of good practices used by real world developers in order to maintain an orderly programming environment. Please read these GitHub guidelines and try to follow them.

Resources

• IntelliJ GitHub/Version-Control Overview
• Overview of how github works (a lot of these can be done in IntelliJ
• IMPORTANT! Good Commit Messages