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
5a5b05c
commit abff008
Showing
1 changed file
with
33 additions
and
29 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 |
|---|---|---|
| @@ -1,60 +1,64 @@ | ||
| # GeekHaven Commmunity App | ||
| **To create a one-stop app for all the management tasks of GeekHaven.**</p> | ||
|
|
||
| ## What issue does this App address? | ||
| ## 🚀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 | ||
| ## 🧷Getting Started | ||
| - [Setup Git](https://git-scm.com/downloads) | ||
| - [Setting up Android Studio](https://developer.android.com/studio/install) | ||
|
|
||
| ## Tech Stack | ||
| ## ✒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. | ||
| ## 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. | ||
|
|
||
| **Directly cloning from Android Studio (Alternate method):-** | ||
| ## How To Contibute | ||
|
|
||
| - Go to FILE -> NEW -> PROJECT FROM VERSION CONTROL | ||
| - Copy and paste the url of FORKED repo in the URL field and click clone. | ||
| We welcome your contributions. Please follow the below guidelines while contributing to this project: | ||
|
|
||
| ## 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) | ||
| 1. Fork the repository and clone locally. | ||
| 2. Create an upstream remote and sync your local copy before your branch. See detailed instructions [here](https://help.github.com/articles/syncing-a-fork) | ||
| 3. Do the work and commit changes with good commit messages. | ||
| 4. Once you are confident in your work, create a pull request to the `master` branch of the upstream repository with proper descriptions explaining what you did and wait until we review it😊. | ||
|
|
||
| ## 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. | ||
| > Check out [GitHub Flow](https://guides.github.com/introduction/flow/) for more details. | ||
| ## 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. | ||
| **Directly cloning from Android Studio (Alternate method):-** | ||
|
|
||
| ## 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. | ||
| - Go to FILE ➡️ NEW ➡️ PROJECT FROM VERSION CONTROL | ||
| - Copy and paste the url of **FORKED repo** in the URL field and click clone. | ||
|
|
||
| - 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. | ||
| ## 🧾Common Rules: | ||
| - The repository is divided into several tasks. **Each task will be opened subsequently for a limited amount of time and all the submissions have to be made within those allotted days only.** NO submission will be accepted after the allotted time ends. The details for the specific tasks and the time allotted for each can be found in their specific issues. | ||
| - The submissions will be judged by the mentors and points🎉 will be allotted by them for each particular task based on various aspects like design thinking process, originality of the idea, visual appeal of the submission, code architecture etc. | ||
| - These tasks are for learning and not just scoring points so any kind of Plagiarism or attempt thereof wouldn't be tolerated and would lead to disqualification from OpenCode. | ||
| - **Your code should be error-free before creating a pull request.** | ||
|
|
||
| - Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students/mentors section. | ||
| > ALL THE FINAL DECISIONS FOR THE JUDGMENT AND AWARDING OF POINTS ⚖️ BASED ON THE SUBMISSION RESIDE WITH THE MENTORS & ORGANISERS. No claim can be made on the number of points awarded by the Mentors & Organisers🙂. | ||
| ## 🗒️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. | ||
|
|
||
| - Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern given in [PR_TEMPLATE.md](https://github.com/opencodeiiita/GeekHaven-Community-App/blob/master/PR_TEMPLATE.md) | ||
|
|
||
| - Provide the link to live gh-pages from your forked repository or relevant screenshot for easier review. | ||
| - Provide the relevant screenshot for easier review. | ||
|
|
||
| - Pull Request older than 2 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. | ||
| ## 📢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😊. | ||
|
|
||
| - Be polite to other community members. | ||
| ## ✒️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) |