forked from opencodeiiita/GeekHaven-Community-App
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1f0a87d
commit 61ba920
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # GeekHaven Commmunity App | ||
| **To create a one-stop app for all the management tasks of GeekHaven.**</p> | ||
|
|
||
| ## What issue does this App address? | ||
| This app would be a one-stop solution for all management tasks of GeekHaven. The app will include a comprehensive space where teams can discuss their ideas, display the current running projects of different wings for better collaboration. | ||
|
|
||
| ## Getting Started | ||
| - [Setup Git](https://git-scm.com/downloads) | ||
| - [Setting up Android Studio](https://developer.android.com/studio/install) | ||
|
|
||
| ## Tech Stack | ||
| * Kotlin | ||
| * Firebase | ||
|
|
||
| ## Requirements | ||
| - Android Studio Giraffe | 2022.3.1 | ||
| - SDK Version: '>=2.18.0 <3.10.0' | ||
|
|
||
| ## How To Setup | ||
| - Make sure your machine is having an internet connection. | ||
| - Fork the repo. | ||
| - Clone it to your local setup by using the command `git clone <repo link>` | ||
| - Open the project with Android Studio. | ||
|
|
||
| **Directly cloning from Android Studio (Alternate method):-** | ||
|
|
||
| - Go to FILE -> NEW -> PROJECT FROM VERSION CONTROL | ||
| - Copy and paste the url of FORKED repo in the URL field and click clone. | ||
|
|
||
| ## Reference Links | ||
| - [Download and install the latest version of Git.](https://git-scm.com/downloads) | ||
| - [Set your username in Git.](https://help.github.com/articles/setting-your-username-in-git) | ||
| - [Set your commit email address in Git.](https://help.github.com/articles/setting-your-commit-email-address-in-git) | ||
| - [Firebase official Documentation](https://firebase.google.com/docs) | ||
| - [Kotlin official Documentation](https://kotlinlang.org/docs/home.html) | ||
|
|
||
| ## Claim an issue | ||
| Comment on the issue. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel. | ||
|
|
||
| ## Communication | ||
| Whether you are working on a new feature or facing a doubt please feel free to ask us on our [discord](https://discord.gg/D9999YTkS8) channel. We will be happy to help you out. | ||
|
|
||
| ## Guidlines | ||
| Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics. | ||
|
|
||
| - People before code: If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors. | ||
|
|
||
| - Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students/mentors section. | ||
|
|
||
| - Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern Fixes #<issue number> <commit message> | ||
|
|
||
| - Provide the link to live gh-pages from your forked repository or relevant screenshot for easier review. | ||
|
|
||
| - Pull Request older than 3 days with no response from the contributor shall be marked closed. | ||
|
|
||
| - Do not make PR which is not related to any issues. You can create an issue and solve it once we approve them. | ||
|
|
||
| - Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself. | ||
|
|
||
| - Be polite to other community members. |