-
Notifications
You must be signed in to change notification settings - Fork 5
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
0 parents
commit 7a853e4
Showing
401 changed files
with
63,293 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# These are supported funding model platforms | ||
|
||
github: Skyost | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: Skyost | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
custom: ['paypal.me/Skyost'] |
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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: Skyost | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: Skyost | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem ? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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 |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Build website | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
- master | ||
pull_request: | ||
branches: | ||
- main | ||
- master | ||
|
||
jobs: | ||
build: | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
matrix: | ||
os: [ ubuntu-latest ] | ||
node: [ latest ] | ||
defaults: | ||
run: | ||
working-directory: ./docs | ||
steps: | ||
- name: Checkout 🛎 | ||
uses: actions/checkout@v3 | ||
- name: Setup Node.js ${{ matrix.node }} 🏗 | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: ${{ matrix.node }} | ||
cache: 'npm' | ||
cache-dependency-path: ./docs/package-lock.json | ||
- name: Install dependencies 👨🏻💻 | ||
run: npm ci | ||
- name: Generate ⚙️ | ||
run: npm run generate | ||
- name: Create .nojekyll file 🧪 | ||
run: touch ./dist/.nojekyll | ||
- name: Deploy 🚀 | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: docs/dist | ||
branch: gh-pages | ||
single-commit: true |
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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Miscellaneous | ||
*.class | ||
*.log | ||
*.pyc | ||
*.swp | ||
.DS_Store | ||
.atom/ | ||
.buildlog/ | ||
.history | ||
.svn/ | ||
migrate_working_dir/ | ||
|
||
# IntelliJ related | ||
*.iml | ||
*.ipr | ||
*.iws | ||
.idea/ | ||
|
||
# The .vscode folder contains launch configuration and tasks you configure in | ||
# VS Code which you may wish to be included in version control, so this line | ||
# is commented out by default. | ||
#.vscode/ | ||
|
||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
**/ios/Flutter/.last_build_id | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.pub-cache/ | ||
.pub/ | ||
/build/ | ||
/devtools_options.yaml | ||
|
||
# Symbolication related | ||
app.*.symbols | ||
|
||
# Obfuscation related | ||
app.*.map.json | ||
|
||
# Android Studio will place build artifacts here | ||
/android/app/debug | ||
/android/app/profile | ||
/android/app/release | ||
|
||
# Bat files | ||
generate.bat | ||
msix.bat | ||
|
||
# Generated files | ||
lib/app.dart | ||
lib/firebase_options.dart | ||
**/*.g.dart | ||
/macos/firebase_app_id_file.json | ||
/ios/firebase_app_id_file.json | ||
/ios/Runner/GoogleService-Info.plist | ||
/macos/Runner/GoogleService-Info.plist | ||
/android/app/google-services.json |
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 |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# This file tracks properties of this Flutter project. | ||
# Used by Flutter tool to assess capabilities and perform upgrades etc. | ||
# | ||
# This file should be version controlled and should not be manually edited. | ||
|
||
version: | ||
revision: "41456452f29d64e8deb623a3c927524bcf9f111b" | ||
channel: "stable" | ||
|
||
project_type: app | ||
|
||
# Tracks metadata for the flutter migrate command | ||
migration: | ||
platforms: | ||
- platform: root | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: android | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: ios | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: linux | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: macos | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: web | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
- platform: windows | ||
create_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
base_revision: 41456452f29d64e8deb623a3c927524bcf9f111b | ||
|
||
# User provided section | ||
|
||
# List of Local paths (relative to this file) that should be | ||
# ignored by the migrate tool. | ||
# | ||
# Files that are not part of the templates will be ignored by default. | ||
unmanaged_files: | ||
- 'lib/main.dart' | ||
- 'ios/Runner.xcodeproj/project.pbxproj' |
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 |
---|---|---|
@@ -0,0 +1,158 @@ | ||
# Contribution Guidelines | ||
|
||
**Note:** If these contribution guidelines are not followed your issue or PR might be closed, so | ||
please read these instructions carefully. | ||
|
||
## Contribution types | ||
|
||
### Bug Reports | ||
|
||
- If you find a bug, please first report it using [Github issues]. | ||
- First check if there is not already an issue for it; duplicated issues will be closed. | ||
|
||
### Bug Fix | ||
|
||
- If you'd like to submit a fix for a bug, please read the [How To](#how-to-contribute) for how to | ||
send a Pull Request. | ||
- Indicate on the open issue that you are working on fixing the bug and the issue will be assigned | ||
to you. | ||
- Write `Fixes #xxxx` in your PR text, where xxxx is the issue number (if there is one). | ||
- Include a test that isolates the bug and verifies that it was fixed. | ||
|
||
### New Features | ||
|
||
- If you'd like to add a feature to the library that doesn't already exist, feel free to describe | ||
the feature in a new [GitHub issue]. | ||
- If you'd like to implement the new feature, please wait for feedback from the project maintainers | ||
before spending too much time writing the code. In some cases, enhancements may not align well | ||
with the project future development direction. | ||
- Implement the code for the new feature and please read the [How To](#how-to-contribute). | ||
|
||
### Documentation & Miscellaneous | ||
|
||
- If you have suggestions for improvements to the documentation, tutorial or examples (or something | ||
else), we would love to hear about it. | ||
- As always first file a [Github issue]. | ||
- Implement the changes to the documentation, please read the [How To](#how-to-contribute). | ||
|
||
## How To Contribute | ||
|
||
### Requirements | ||
|
||
For a contribution to be accepted : | ||
|
||
- Format your code; | ||
- Documentation should always be updated or added (if applicable); | ||
- The PR title should start with a [conventional commit] prefix (`feat:`, `fix:` etc). | ||
|
||
If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the issue | ||
or PR. You can still continue to add more commits to the branch you have sent the Pull Request from | ||
and it will be automatically reflected in the PR. | ||
|
||
### Environment Setup | ||
|
||
Open Authenticator is setup to run with the most recent `stable` version of Flutter, so make sure your version | ||
matches that : | ||
|
||
```shell | ||
flutter channel stable | ||
``` | ||
|
||
Then, to download required dependencies, run the following command in the app directory : | ||
|
||
```shell | ||
flutter pub get | ||
``` | ||
|
||
You will then need to configure your Firebase environment : | ||
|
||
```shell | ||
dart pub global activate flutterfire_cli | ||
flutterfire configure | ||
``` | ||
|
||
Now, generate the remaining files required by Open Authenticator : | ||
|
||
```shell | ||
dart run build_runner build | ||
dart run slang | ||
dart run open_authenticator:generate | ||
``` | ||
|
||
### Performing changes | ||
|
||
- Create a new local branch from `main` (e.g. `git checkout -b my-new-feature`) | ||
- Make your changes (try to split them up with one PR per feature/fix). | ||
- When committing your changes, make sure that each commit message is clear | ||
(e.g. `git commit -m 'My very clear commit message'`). | ||
- Push your new branch to your own fork into the same remote branch | ||
(e.g. `git push origin my-username.my-new-feature`, replace `origin` if you use another remote.) | ||
|
||
### Breaking changes | ||
|
||
When doing breaking changes a deprecation tag should be added when possible and contain a message | ||
that conveys to the user what which version that the deprecated method/field will be removed in and | ||
what method they should use instead to perform the task. The version specified should be at least | ||
two versions after the current one, such that there will be at least one stable release where the | ||
users get to see the deprecation warning and in the version after that (or a later version) the | ||
deprecated entity should be removed. | ||
|
||
Example (if the current version is v4.1.0) : | ||
|
||
```dart | ||
@Deprecated('Will be removed in v4.2.0, use nonDeprecatedFeature() instead') | ||
void deprecatedFeature() {} | ||
``` | ||
|
||
|
||
### Open a pull request | ||
|
||
Go to the [pull request page of Open Authenticator][PRs] and in the top | ||
of the page it will ask you if you want to open a pull request from your newly created branch. | ||
|
||
The title of the pull request should start with a [conventional commit] type. | ||
|
||
Allowed types are : | ||
|
||
- `fix:` -- patches a bug and is not a new feature; | ||
- `feat:` -- introduces a new feature; | ||
- `docs:` -- updates or adds documentation or examples; | ||
- `test:` -- updates or adds tests; | ||
- `refactor:` -- refactors code but doesn't introduce any changes or additions to the public API; | ||
- `perf:` -- code change that improves performance; | ||
- `build:` -- code change that affects the build system or external dependencies; | ||
- `ci:` -- changes to the CI configuration files and scripts; | ||
- `chore:` -- other changes that don't modify source or test files; | ||
- `revert:` -- reverts a previous commit. | ||
|
||
If you introduce a **breaking change** the conventional commit type MUST end with an exclamation | ||
mark (e.g. `feat!: Remove the position argument from PositionComponent`). | ||
|
||
## Maintainers | ||
|
||
These instructions are for the maintainers of Open Authenticator. | ||
|
||
### Merging a pull request | ||
|
||
When merging a pull request, make sure that the title of the merge commit has the correct | ||
conventional commit tag and a descriptive title. This is extra important since sometimes the title | ||
of the PR doesn't reflect what GitHub defaults to for the merge commit title (if the title has been | ||
changed during the life time of the PR for example). | ||
|
||
All the default text should be removed from the commit message and the PR description and the | ||
instructions from the "Migration instruction" (if the PR is breaking) should be copied into the | ||
commit message. | ||
|
||
### Creating a release | ||
|
||
There are a few things to think about when doing a release: | ||
|
||
- Search through the codebase for `@Deprecated` methods/fields and remove the ones that are marked | ||
for removal in the version that you are intending to release. | ||
- Create a PR containing the changes for removing the deprecated entities. | ||
|
||
[GitHub issue]: https://github.com/Skyost/OpenAuthenticator/issues | ||
[GitHub issues]: https://github.com/Skyost/OpenAuthenticator/issues | ||
[PRs]: https://github.com/Skyost/OpenAuthenticator/pulls | ||
[pubspec doc]: https://dart.dev/tools/pub/pubspec | ||
[conventional commit]: https://www.conventionalcommits.org |
Oops, something went wrong.