Skip to content

Commit b841832

Browse files
brunotaccabrunotacca
committed
Initial commit
0 parents  commit b841832

16 files changed

+528
-0
lines changed

‎.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ko_fi: tacca

‎.github/ISSUE_TEMPLATE/1_installation.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: I am having difficulty setting up project or getting it to work
3+
about: You have run into problems while setting up this project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- Thank you for helping!
10+
11+
If you are looking for support, please check out our documentation or consider asking a question on our Discussions:
12+
* https://github.com/brunotacca/???CHANGE-ME???/discussions
13+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/GET_STARTED.md
14+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/SUPPORT.md
15+
16+
If you have found a bug or if our documentation doesn't have an answer
17+
to what you're looking for, then fill out the template below.
18+
-->
19+
20+
## What's happening?
21+
22+
<!-- Please tell us exactly what's happening in a summarized way -->
23+
24+
25+
## Steps to Reproduce
26+
27+
<!-- Please tell us exactly how to reproduce the problem you are running into. -->
28+
29+
1. ...
30+
2. ...
31+
3. ...
32+
33+
## Logs
34+
35+
<details>
36+
<summary>Logs</summary>
37+
38+
<!--
39+
Feel free to add any error messages and logs you can collect.
40+
-->
41+
42+
```
43+
Paste it here.
44+
```
45+
46+
</details>

‎.github/ISSUE_TEMPLATE/2_bug_report.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: I found a problem with my project.
3+
about: You are using this project but the software is crashing, something is buggy and looks wrong.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- Thank you for helping!
10+
11+
If you are looking for support, please check out our documentation or consider asking a question on our Discussions:
12+
* https://github.com/brunotacca/???CHANGE-ME???/discussions
13+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/GET_STARTED.md
14+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/SUPPORT.md
15+
16+
If you have found a bug or if our documentation doesn't have an answer
17+
to what you're looking for, then fill out the template below.
18+
-->
19+
20+
## What's happening?
21+
22+
<!-- Please tell us exactly what's happening in a summarized way -->
23+
24+
25+
## Steps to Reproduce
26+
27+
<!-- Please tell us exactly how to reproduce the problem you are running into. -->
28+
29+
1. ...
30+
2. ...
31+
3. ...
32+
33+
**Expected results:** <!-- what did you want to see? -->
34+
35+
**Actual results:** <!-- what did you see? -->
36+
37+
<details>
38+
<summary>Code sample</summary>
39+
40+
<!--
41+
Please create a minimal reproducible sample that shows the problem
42+
and attach it below between the lines with the backticks.
43+
-->
44+
45+
```dart
46+
Paste your minimal code sample here.
47+
```
48+
49+
</details>
50+
51+
<details>
52+
<summary>Logs</summary>
53+
54+
<!--
55+
Feel free to add any error messages and logs you can collect.
56+
-->
57+
58+
```
59+
Paste it here.
60+
```
61+
62+
</details>

‎.github/ISSUE_TEMPLATE/3_feature_request.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new idea for this project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Thank you for helping!
11+
12+
If you are looking for support, please check out our documentation or consider asking a question on our Discussions:
13+
* https://github.com/brunotacca/???CHANGE-ME???/discussions
14+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/GET_STARTED.md
15+
* https://github.com/brunotacca/???CHANGE-ME???/blob/main/docs/SUPPORT.md
16+
17+
-->
18+
19+
## Use case
20+
21+
<!--
22+
Please tell us the problem you are running into that led to you wanting
23+
a new feature.
24+
25+
Is your feature request related to a problem? Please give a clear and
26+
concise description of what the problem is.
27+
28+
Describe the alternative solutions you've considered.
29+
-->
30+
31+
## Proposal
32+
33+
<!--
34+
Briefly but precisely describe what you would like the project to be able to do.
35+
36+
Consider attaching something showing what you are imagining:
37+
* images
38+
* videos
39+
* code samples
40+
-->

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: I want help with this repository
4+
url: https://github.com/brunotacca/???CHANGE-ME???/discussions
5+
about: Ask your questions about how to achieve a particular objective within this project.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Fixes
2+
<!-- If PR doesn't fully resolve the issue, replace 'Fixes' below with 'Related to'. -->
3+
<!-- If there is no issue being resolved, please open one before creating this pull request. -->
4+
Fixes #[issue number] by @[issue author]
5+
6+
## Description
7+
<!-- Concisely describe what the pull request does. -->
8+
9+
## Technical details
10+
<!-- Add any other information or technical details about the implementation; or delete this section entirely. -->
11+
12+
## Tests
13+
<!-- Give steps for the reviewer to verify that this PR fixes the problem; or delete this section entirely. -->
14+
15+
## Screenshots
16+
<!-- Add screenshots to show the problem and the solution; or delete this section entirely. -->
17+
18+
## Mandatory Pre-launch Checklist
19+
<!-- Replace the [ ] with [x] to check the boxes. -->
20+
- [ ] I read and agree with the [Code of Conduct](../docs/CODE_OF_CONDUCT.md).
21+
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
22+
- [ ] My pull request has a descriptive title (not a vague title like `Update index.md`).
23+
- [ ] My pull request targets the *default* branch of the repository (`main`).
24+
- [ ] My code follows the established code style of the repository.
25+
- [ ] I listed at least one issue that this PR fixes in the description above.
26+
- [ ] I added or updated tests for the changes I made (if applicable).
27+
- [ ] I verified that all existing and new tests are passing.
28+
- [ ] I tried running the project locally and verified that there are no visible errors.
29+
30+
## Admired Pre-launch Checklist
31+
- [ ] My commit messages follow [best practices][best_practices].
32+
- [ ] I added or updated documentation (if applicable).
33+
34+
[best_practices]:https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53

‎CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
### [Unreleased]
8+
9+
[Unreleased]: https://github.com/brunotacca/???CHANGE-ME???/???REF-CHANGE-ME???...HEAD

‎CITATION.cff

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cff-version: 1.2.0
2+
message: "If you use this code, please cite it as below."
3+
authors:
4+
- family-names: "Oliveira"
5+
given-names: "Bruno Vitorelli Tacca"
6+
orcid: "https://orcid.org/0000-0002-2996-8360"
7+
title: "Project Title CHANGE-ME"
8+
url: "https://github.com/brunotacca/???CHANGE-ME???"
9+
year: 2022
10+
version: 0.0.0-WIP
11+
preferred-citation:
12+
type: software
13+
authors:
14+
- family-names: "Oliveira"
15+
given-names: "Bruno Vitorelli Tacca"
16+
orcid: "https://orcid.org/0000-0002-2996-8360"
17+
title: "Project Title CHANGE-ME"
18+
url: "https://github.com/brunotacca/???CHANGE-ME???""
19+
year: 2022
20+
version: 0.0.0-WIP

‎CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# For more information about this file syntax please refer to:
2+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
3+
4+
* @brunotacca

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Bruno V. Tacca de Oliveira
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)