Skip to content

Commit

Permalink
chore: added Contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
TesteurManiak committed Jul 28, 2023
1 parent 6a2448a commit 2edcdeb
Show file tree
Hide file tree
Showing 11 changed files with 184 additions and 21 deletions.
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Contributing to Flutter Manga Reader

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:

1. Fork the repo and create your branch from `main` if you're working on a fix or `dev` if you're on a feature.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation and write the migration steps.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/Floating-Dartists/matomo-tracker/issues)

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Floating-Dartists/matomo-tracker/issues/new/choose); it's that easy!

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People *love* thorough bug reports. I'm not even kidding.

## Use a Consistent Coding Style

* [Flutter style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo)
* [Dart style guide](https://dart.dev/effective-dart)
* Avoid the usage of the `!` or `as` operators as they are not typesafe

## License

By contributing, you agree that your contributions will be licensed under its MIT License.

## References

This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
16 changes: 0 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

A cross-platform manga reader.

Made by [Michel "Meï" Mancier][mei_link] and [Guillaume Roux][guillaume_link] with inspiration from the [Floating Dartists][floating_dartists_link] organization maintained by both of them and [Pierre Monier][pierre_link].

## Getting Started

This project contains 3 flavors:
Expand Down Expand Up @@ -139,24 +137,10 @@ This project uses [flutter_launcher_icons][flutter_launcher_icons_link] to gener
$ dart run flutter_launcher_icons
```

## Generating Splash Screens

This project uses [flutter_native_splash][flutter_native_splash_link] to generate the splash screens. To modify the splash screens follow these steps:

_Section coming soon_

```sh
$ dart run flutter_native_splash:create
```

## Credits

* [MangaDex][manga_dex]: For providing the API used in this project

[mei_link]: https://github.com/MeixDev
[guillaume_link]: https://github.com/TesteurManiak
[floating_dartists_link]: https://github.com/Floating-Dartists
[pierre_link]: https://github.com/Pierre-Monier
[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html
[internationalization_guide_link]: https://docs.flutter.dev/accessibility-and-localization/internationalization
[flutter_gen_runner_link]: https://pub.dev/packages/flutter_gen_runner
Expand Down
2 changes: 2 additions & 0 deletions lib/core/sources/drift_datasource/app_database.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ part 'app_database.g.dart';

class DbMangas extends Table {
TextColumn get id => text()();
BoolColumn get favorite => boolean().withDefault(const Constant(false))();
TextColumn get url => text()();
TextColumn get source => text()();
TextColumn get title => text()();
TextColumn get artist => text().nullable()();
TextColumn get author => text().nullable()();
Expand Down
Loading

0 comments on commit 2edcdeb

Please sign in to comment.