Skip to content

Commit e4be3bb

Browse files
committed
chore: Updated README, contribution guidelines and issue templates.
1 parent c401feb commit e4be3bb

5 files changed

Lines changed: 94 additions & 56 deletions

File tree

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: bug
6-
assignees: Skyost
3+
about: Report a bug of Open Authenticator
4+
title: "fix: "
5+
labels: ["bug"]
6+
assignees: ["Skyost"]
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
## Describe the bug
1211

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
12+
Provide a clear and concise description of what the bug is.
13+
14+
## To Reproduce
15+
16+
To reproduce the behavior :
1517
1. Go to '...'
1618
2. Click on '....'
1719
3. Scroll down to '....'
1820
4. See error
1921

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
22+
## Expected behavior
23+
24+
Give a clear and concise description of what you expected to happen.
25+
26+
## Screenshots
2227

23-
**Screenshots**
2428
If applicable, add screenshots to help explain your problem.
2529

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30+
## Environment
31+
32+
**Desktop (if applicable, please complete the following information) :**
33+
* OS : [e.g. iOS]
34+
* Browser : [e.g. chrome, safari]
35+
* Version : [e.g. 22]
36+
37+
**Smartphone (if applicable, please complete the following information) :**
38+
* Device: [e.g. iPhone6]
39+
* OS: [e.g. iOS8.1]
40+
* Browser [e.g. stock browser, safari]
41+
* Version [e.g. 22]
3042

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
43+
## Additional context
3644

37-
**Additional context**
3845
Add any other context about the problem here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Documentation
3+
about: Report a documentation or content improvement
4+
title: "docs: "
5+
labels: ["documentation"]
6+
assignees: ["Skyost"]
7+
---
8+
9+
## Affected page
10+
11+
Provide the related URL or file path.
12+
13+
## Current problem
14+
15+
Explain what is incorrect, missing, ambiguous, or outdated.
16+
17+
## Proposed update
18+
19+
Describe the expected content.
20+
21+
## Additional context
22+
23+
Add any useful context, source, or screenshot.
Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: ''
5-
labels: enhancement
4+
title: "feat: "
5+
labels: ["enhancement"]
66
assignees: Skyost
77

88
---
99

10-
**Is your feature request related to a problem ? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## Need
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
Describe the problem or user need.
1513

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
14+
## Proposed solution
1815

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
16+
Describe the change you would like to see.
17+
18+
## Alternatives considered
19+
20+
List any alternatives or approaches already considered.
21+
22+
## Expected impact
23+
24+
Explain the value for other users, contributors, or maintainers.
25+
Also explain the impact on the backend.
26+
27+
## Additional context
28+
29+
Links, mockups, screenshots, references, etc.

CONTRIBUTING.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribution Guidelines
22

3-
**Note:** If these contribution guidelines are not followed your issue or PR might be closed, so
3+
**Note :** If these contribution guidelines are not followed your issue or PR might be closed, so
44
please read these instructions carefully.
55

66
## Contribution types
@@ -64,13 +64,6 @@ Then, to download required dependencies, run the following command in the app di
6464
flutter pub get
6565
```
6666

67-
You will then need to configure your Firebase environment :
68-
69-
```shell
70-
dart pub global activate flutterfire_cli
71-
flutterfire configure
72-
```
73-
7467
Now, generate the remaining files required by Open Authenticator :
7568

7669
```shell
@@ -161,8 +154,8 @@ dart run open_authenticator:version
161154
Note that you need a Github PAT that has write access to the current repository. It should be put
162155
in a `.env` file under the key `GITHUB_PAT`.
163156

164-
[GitHub issue]: https://github.com/Skyost/OpenAuthenticator/issues
165-
[GitHub issues]: https://github.com/Skyost/OpenAuthenticator/issues
166-
[PRs]: https://github.com/Skyost/OpenAuthenticator/pulls
157+
[GitHub issue]: https://github.com/openauthenticator-app/openauthenticator/issues
158+
[GitHub issues]: https://github.com/openauthenticator-app/openauthenticator/issues
159+
[PRs]: https://github.com/openauthenticator-app/openauthenticator/pulls
167160
[pubspec doc]: https://dart.dev/tools/pub/pubspec
168161
[conventional commit]: https://www.conventionalcommits.org

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<a href="https://openauthenticator.app">
3-
<img src="https://github.com/Skyost/OpenAuthenticator/raw/main/docs/public/images/logo.svg" alt="Logo" width="120" height="120">
3+
<img src="https://github.com/openauthenticator-app/openauthenticator/raw/main/docs/public/images/logo.svg" alt="Logo" width="120" height="120">
44
</a>
55

66
<h3>Open Authenticator</h3>
@@ -21,9 +21,9 @@
2121
</p>
2222

2323
<p>
24-
<img src="https://img.shields.io/github/license/openauthenticator-app/backend" alt="License">
25-
<img src="https://img.shields.io/github/languages/top/openauthenticator-app/backend" alt="Top language">
26-
<img src="https://img.shields.io/github/stars/openauthenticator-app/backend" alt="GitHub stars">
24+
<img src="https://img.shields.io/github/license/openauthenticator-app/openauthenticator" alt="License">
25+
<img src="https://img.shields.io/github/languages/top/openauthenticator-app/openauthenticator" alt="Top language">
26+
<img src="https://img.shields.io/github/stars/openauthenticator-app/openauthenticator" alt="GitHub stars">
2727
</p>
2828
</div>
2929

@@ -40,10 +40,13 @@ The project focuses on three core ideas :
4040

4141
Open Authenticator currently targets Android, iOS, Windows, macOS and Linux.
4242

43+
> [!TIP]
44+
> If you like this project, consider starring it on GitHub !
45+
4346
## Features
4447

4548
- Cross-platform Flutter application for mobile and desktop.
46-
- Free and open-source software under the [GPL v3.0 license](https://github.com/Skyost/OpenAuthenticator/blob/main/LICENSE).
49+
- Free and open-source software under the [GPL v3.0 license](https://github.com/openauthenticator-app/openauthenticator/blob/main/LICENSE).
4750
- Secure local storage for your OTP data.
4851
- QR code scanning and `otpauth://` link handling.
4952
- Optional synchronization across devices with self-hostable backend support.
@@ -63,8 +66,8 @@ Prebuilt packages and store links are available on the [official website](https:
6366

6467
### Prerequisites
6568

66-
- A recent stable version of Flutter.
67-
- Dart SDK `>=3.10.0 <4.0.0`.
69+
- A recent stable version of **Flutter**.
70+
- **Dart** SDK `>=3.10.0 <4.0.0`.
6871
- Platform toolchains for the targets you want to run.
6972

7073
It is recommended to stay on Flutter stable :
@@ -88,20 +91,20 @@ flutter pub get
8891

8992
Some files used by the app are generated or refreshed during setup.
9093

91-
1. Compile SVG assets to `.si`:
94+
First, compile SVG assets to `.si` :
9295

9396
```sh
9497
dart run open_authenticator:compile_svg
9598
```
9699

97-
2. Generate source files used by code generation:
100+
Then, generate source files used by code generation :
98101

99102
```sh
100103
dart run build_runner build --delete-conflicting-outputs
101104
dart run slang
102105
```
103106

104-
3. Generate `lib/app.dart` for your local build:
107+
Last but not least, generate `lib/app.dart` for your local build :
105108

106109
```sh
107110
dart run open_authenticator:generate
@@ -127,24 +130,26 @@ you want to run against.
127130

128131
### Run the app
129132

133+
To run the app :
134+
130135
```sh
131136
flutter run
132137
```
133138

134139
## Contributing
135140

136141
Contributions are more than welcome. For setup details, contribution rules and PR expectations, read
137-
[CONTRIBUTING.md](https://github.com/Skyost/OpenAuthenticator/blob/main/CONTRIBUTING.md).
142+
[CONTRIBUTING.md](https://github.com/openauthenticator-app/openauthenticator/blob/main/CONTRIBUTING.md).
138143

139144
You can also help by :
140145

141146
- reporting bugs or suggesting features in the
142-
[issue tracker](https://github.com/Skyost/OpenAuthenticator/issues) ;
147+
[issue tracker](https://github.com/openauthenticator-app/openauthenticator/issues) ;
143148
- improving translations through the
144149
[translation page](https://openauthenticator.app/translate/) ;
145150
- submitting fixes for documentation, UI text or code.
146151

147-
## Support The Project
152+
## Support the project
148153

149154
If you want to support Open Authenticator financially, you can use :
150155

@@ -154,4 +159,5 @@ If you want to support Open Authenticator financially, you can use :
154159

155160
## License
156161

157-
Open Authenticator is licensed under the [GNU General Public License v3.0](LICENSE).
162+
Open Authenticator is licensed under the
163+
[GNU General Public License v3.0](https://github.com/openauthenticator-app/openauthenticator/blob/main/LICENSE).

0 commit comments

Comments
 (0)