eb88967545
* Navigate users to library page instead of home to prevent history block. * Cleaned up the Contributing to describe new code structure * Fixed a critical bug for how we find files for a chapter download (use ChapterId for lookup, not MangaFile.Id). Refactored how downloading works on the UI side to use the backend's filename whenever possible, else provide a custom name (and use backend's extension) for bundled downloads. * Fixed a bug where scroll intersection wasn't working on books without a table of content, even though it should have. * If user is using a direct url and hits an authentication guard, cache the url, allow authentication, then redirect them to said url * Added a transaction for bookmarking due to a rare case (in dev machines) where bookmark progress can duplicate * Re-enabled webtoon preference in reader settings. Refactored gotopage into it's own, dedicated handler to simplify logic. * Moved the prefetching code to occur whenever the page number within infinite scroller changes. This results in an easier to understand functioning. * Fixed isElementVisible() which was not properly calculating element visibility * GoToPage going forwards is working as expected, going backwards is completly broken * After performing a gotopage, make sure we update the scrolling direction based on the delta. * Removed some stuff thats not used, split the prefetching code up into separate functions to prepare for a rewrite. * Reworked prefetching to ensure we have a buffer of pages around ourselves. It is not fully tested, but working much better than previous implementation. Will be enhanced with DOM Pruning. * Cleaned up some old cruft from the backend code * Cleaned up the webtoon page change handler to use setPageNum, which will handle the correct prefetching of next/prev chapter * More cleanup around the codebase * Refactored the code to use a map to keep track of what is loaded or not, which works better than max/min in cases where you jump to a page that doesn't have anything preloaded and loads images out of order * Fixed a bad placement of code for when you are unauthenticated, the code will now redirect to the original location you requested before you had to login. * Some cleanup. Fixed the scrolling issue with prev page, spec seems to not work on intersection observer. using 0.01 instead of 0.0.
57 lines
3 KiB
Markdown
57 lines
3 KiB
Markdown
# How to Contribute #
|
|
|
|
We're always looking for people to help make Kavita even better, there are a number of ways to contribute.
|
|
|
|
## Documentation ##
|
|
Setup guides, FAQ, the more information we have on the [wiki](https://github.com/Kareadita/Kavita/wiki) the better.
|
|
|
|
## Development ##
|
|
|
|
### Tools required ###
|
|
- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/). The community version is free and works fine. [Download it here](https://www.visualstudio.com/downloads/).
|
|
- Rider (optional to Visual Studio) (https://www.jetbrains.com/rider/)
|
|
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
|
|
- [Git](https://git-scm.com/downloads)
|
|
- [NodeJS](https://nodejs.org/en/download/) (Node 14.X.X or higher)
|
|
- .NET 5.0+
|
|
|
|
### Getting started ###
|
|
|
|
1. Fork Kavita
|
|
2. Clone the repository into your development machine. [*info*](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github)
|
|
3. Install the required Node Packages
|
|
- cd Kavita/UI/Web
|
|
- `npm install`
|
|
- `npm install -g @angular/cli`
|
|
4. Start angular server `ng serve`
|
|
5. Build the project in Visual Studio/Rider, Setting startup project to `API`
|
|
6. Debug the project in Visual Studio/Rider
|
|
7. Open http://localhost:4200
|
|
8. (Deployment only) Run build.sh and pass the Runtime Identifier for your OS or just build.sh for all supported RIDs.
|
|
|
|
|
|
### Contributing Code ###
|
|
- If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Kareadita/Kavita/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first)
|
|
- Rebase from Kavita's develop branch, don't merge
|
|
- Make meaningful commits, or squash them
|
|
- Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements
|
|
- Reach out to us on the discord if you have any questions
|
|
- Add tests (unit/integration)
|
|
- Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
|
|
- One feature/bug fix per pull request to keep things clean and easy to understand
|
|
- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge)
|
|
- Use 2 spaces for UI files
|
|
|
|
### Pull Requesting ###
|
|
- Only make pull requests to develop, never main, if you make a PR to main we'll comment on it and close it
|
|
- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
|
|
- We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
|
|
- Each PR should come from its own [feature branch](http://martinfowler.com/bliki/FeatureBranch.html) not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
|
|
- new-feature (Good)
|
|
- fix-bug (Good)
|
|
- patch (Bad)
|
|
- develop (Bad)
|
|
- feature/parser-enhancements (Great)
|
|
- bugfix/book-issues (Great)
|
|
|
|
If you have any questions about any of this, please let us know.
|