Skip to content

Commit

Permalink
added contributing | bumped up version
Browse files Browse the repository at this point in the history
  • Loading branch information
ap-atul committed Feb 14, 2023
1 parent 713b37b commit e122063
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 12 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## General

- You (contributor) are allowed to update any piece of code you see fit.
- Few guidelines
- `Constants` should be defined in `config/Ranobe.java`
- Follow clean coding standards
- Try not to add third-party libraries (for package sizes concerns)
- If possible, minimize the app size (that would be great)

## Adding a new source

- The file for the source should be added under `/sources/<lang>/`
- The name of the file should be `<SiteName>.java`
- Implement `Source.java` interface for adding a new source
- If for some reason a method is not possible to implement throw a proper `Exception` with the
message
- Ex ```throw new Exception("I am sorry")```
- Test the source properly before creating a PR
- Once done, raise a PR with the title `Add new source: <SOURCE_NAME_HERE>`, the branch name can
be `source/<source_name>`

## Rules

- Do not define `Novel` and `NovelItem`'s `id` field since it is calculated in the constructor.
- Do not define `Chapter` and `ChapterItem`'s `novelId` field since it is calculated in the
constructor,
whereas the `id` field should be the chapter no for the novel
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<h2><samp>R.A.N.O.B.E</samp></h2>
<samp>A simple extensible light novel reader</samp>
<br/><br/>
<a href="https://github.com/ranobe-org/ranobe/releases/download/v0.0.3/ranobe.apk" title="Download">
<a href="https://github.com/ranobe-org/ranobe/releases/download/v0.0.4/ranobe.apk" title="Download">
<img height='30' src="https://img.shields.io/badge/download-2da44e?style=flat&logo=android&logoColor=white" alt="Download" title="Download">
</a>
<a href="https://apt.izzysoft.de/fdroid/index/apk/org.ranobe.ranobe" title="Download from Izzydroid">
Expand Down Expand Up @@ -66,7 +66,7 @@
- [ ] add to library, only store novel in db
- [ ] download chapters for offline view, save everything to db
- [ ] saving read state for each item
- [ ] more sources (currently has 5)
- [ ] more sources (currently has 8)

#### could have

Expand All @@ -77,11 +77,3 @@
- [ ] backup data, migrations
- [ ] novel updates
- [ ] animations

---------------

### Guidelines

1. Sources should not define `Novel` and `NovelItem`'s `id` field since it is calculated in constructor.
2. Sources should not define `Chapter` and `ChapterItem`'s `novelId` field since it is calculated in constructor,
whereas the `id` field should be the chapter no for the novel
4 changes: 2 additions & 2 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ android {
applicationId "org.ranobe.ranobe"
minSdk 21
targetSdk 33
versionCode 3
versionName "v0.0.3"
versionCode 4
versionName "v0.0.4"
}

buildTypes {
Expand Down

0 comments on commit e122063

Please sign in to comment.