Skip to content

Commit eed55f2

Browse files
committed
chore: update repository docs
1 parent ad17031 commit eed55f2

File tree

3 files changed

+12
-32
lines changed

3 files changed

+12
-32
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to FastHub
1+
# Contributing to FastHub-RE
22

3-
**Updated: 19 Jan 2018**
3+
**Updated: 19 April 2022**
44

55
## Table of contents
66

@@ -24,22 +24,9 @@
2424
- Make sure you are running latest version (to check it out withing the FastHub head to About and tap on the section with application's version).
2525
- Make sure the included template is filled in (submitting an Issue within FastHub will do it automatically).
2626

27-
## How to contribute. Importing and assembling
28-
29-
If you have any questions, feel free to join our public [Slack](http://rebrand.ly/fasthub) channel.
30-
31-
### Custom keys *(optional)*
32-
33-
- Please update `debug_gradle.properties` file if you want to use your own keys:
34-
- `github_client_id=` -- your GitHub clientId;
35-
- `github_secret=` -- your GitHub secret;
36-
- `redirect_url=` -- the url defined in `AndroidManifest` under `LoginView`.
37-
3827
### Before importation
3928

40-
- Make sure you are running *Android Studio 3.0 C4* or above;
41-
- Import *Android Studio Settings* (to follow project's code style) from [this file](https://raw.githubusercontent.com/k0shk0sh/FastHub/master/fasthub_as_settings.jar);
42-
- Install *Lombok Plugin* from Android Studio Plugins and enable Annotations Processors in Android Studio Preferences.
29+
- Make sure you are running *Android Studio 2021* or above;
4330

4431
### Importing Android Studio project
4532

@@ -83,7 +70,3 @@ If you have any questions, feel free to join our public [Slack](http://rebrand.l
8370
1. Once you finished translating, add new files to the Git index using `git add values-??/strings.xml` command and commit the changes using `git commit -m '<commit message>'`, where `<commit message>` is a short description of changes you made.
8471
1. Push your local changes into your forked repository by typing `git push origin <new branch>`.
8572
1. Finally, create a Pull Request from your Branch to our main Branch *development*.
86-
87-
## Translations Contributors
88-
89-
- *See [README.md](https://github.com/k0shk0sh/FastHub#language-contributors)*

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,15 @@ assignees: ''
1212
- Add screenshots if appropriate.
1313
- Make sure that you are always on the latest version.
1414
- Search issue before submitting a new one.
15-
16-
Public Slack channel: https://rebrand.ly/fasthub
17-
18-
#### How to submit Issue/Feature Request to *FastHub*
19-
- Make sure the included template is filled ( using FastHub will fill them up automatically ).
15+
16+
#### How to submit Issue/Feature Request to *FastHub-RE*
17+
- Make sure the included template is filled ( using FastHub-RE will fill them up automatically ).
2018
- If you planning to report multiple FRs/Issues that falls under the same category ~PLEASE REPORT THEM IN ONE TICKET~.
21-
- Make sure you are always on latest (FastHub/About & Click on version name).
19+
- Make sure you are always on latest (FastHub-RE/About & Click on version name).
2220
- Make sure the issue doesn't exists, lets keep things clean & tidy here :).
2321
-->
2422

25-
**FastHub Version:** <!-- Don't forget to mention "Enterprise" here if needed. -->
23+
**FastHub-RE Version:** <!-- Don't forget to mention "Enterprise" here if needed. -->
2624
**Android Version:**
2725
**Device Information:**
2826
- MANUFACTURER: <!-- e.g. Yota Devices Limited -->

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ To build a debug version you can just import the project and start the building
109109

110110
To build your own release application you need to create a `secrets.properties` inside `/app/` with your custom credentials:
111111

112-
- **STORE_PASSWORD**=`here`
113-
- **KEY_PASSWORD**=`here`
112+
- **PASSWORD**=`here`
113+
- **KEY_ALIAS**=`here`
114114
- **GITHUB_CLIENT_ID**=`here`
115115
- **GITHUB_SECRET**=`here`
116116
- **IMGUR_CLIENT_ID**=`here`
@@ -120,14 +120,13 @@ Then, create your own keystore and put it in `/app/keys_release.jks`.
120120

121121
## :book: Spec / Open-Source libraries:
122122

123-
- Minimum **SDK 21**, _but AppCompat is used all the way ;-)_
124-
- [**Kotlin**](https://github.com/JetBrains/kotlin) all new modules starting from 2.5.3 will be written in **#Kotlin**.
123+
- Minimum **SDK 25**
124+
- [**Kotlin**](https://github.com/JetBrains/kotlin)
125125
- **MVP**-architecture: [**ThirtyInch**](https://github.com/grandcentrix/ThirtyInch) because its ThirtyInch.
126126
- [**RxJava2**](https://github.com/ReactiveX/RxJava) & [**RxAndroid**](https://github.com/ReactiveX/RxAndroid) for Retrofit & background threads
127127
- [**Retrofit**](https://github.com/square/retrofit) for constructing the REST API
128128
- [**Requery**](https://github.com/requery/requery/) for offline-mode
129129
- [**Stream API**](https://github.com/aNNiMON/Lightweight-Stream-API) for dealing with `Collections`
130-
- [**ButterKnife**](https://github.com/JakeWharton/butterknife) for view binding
131130
- [**Android State**](https://github.com/evernote/android-state) for saving instance states
132131
- [**Material-BottomNavigation**](https://github.com/sephiroth74/Material-BottomNavigation) for `BottomBar` tabs
133132
- [**FastHub Contribution View**](https://github.com/KaustubhPatange/fasthub-contribution-view) for the contribution listing

0 commit comments

Comments
 (0)