-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Create
academic_calendar
package
- Loading branch information
Showing
24 changed files
with
524 additions
and
0 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
packages/academic_calendar/.github/ISSUE_TEMPLATE/bug_report.md
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,29 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: "fix: " | ||
labels: bug | ||
--- | ||
|
||
**Description** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**Steps To Reproduce** | ||
|
||
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. | ||
|
||
**Additional Context** | ||
|
||
Add any other context about the problem here. |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/build.md
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,14 @@ | ||
--- | ||
name: Build System | ||
about: Changes that affect the build system or external dependencies | ||
title: "build: " | ||
labels: build | ||
--- | ||
|
||
**Description** | ||
|
||
Describe what changes need to be done to the build system and why. | ||
|
||
**Requirements** | ||
|
||
- [ ] The build system is passing |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/chore.md
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,14 @@ | ||
--- | ||
name: Chore | ||
about: Other changes that don't modify src or test files | ||
title: "chore: " | ||
labels: chore | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what change is needed and why. If this changes code then please use another issue type. | ||
|
||
**Requirements** | ||
|
||
- [ ] No functional changes to the code |
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,14 @@ | ||
--- | ||
name: Continuous Integration | ||
about: Changes to the CI configuration files and scripts | ||
title: "ci: " | ||
labels: ci | ||
--- | ||
|
||
**Description** | ||
|
||
Describe what changes need to be done to the ci/cd system and why. | ||
|
||
**Requirements** | ||
|
||
- [ ] The ci system is passing |
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 @@ | ||
blank_issues_enabled: false |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/documentation.md
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,14 @@ | ||
--- | ||
name: Documentation | ||
about: Improve the documentation so all collaborators have a common understanding | ||
title: "docs: " | ||
labels: documentation | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what documentation you are looking to add or improve. | ||
|
||
**Requirements** | ||
|
||
- [ ] Requirements go here |
18 changes: 18 additions & 0 deletions
18
packages/academic_calendar/.github/ISSUE_TEMPLATE/feature_request.md
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,18 @@ | ||
--- | ||
name: Feature Request | ||
about: A new feature to be added to the project | ||
title: "feat: " | ||
labels: feature | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what you are looking to add. The more context the better. | ||
|
||
**Requirements** | ||
|
||
- [ ] Checklist of requirements to be fulfilled | ||
|
||
**Additional Context** | ||
|
||
Add any other context or screenshots about the feature request go here. |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/performance.md
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,14 @@ | ||
--- | ||
name: Performance Update | ||
about: A code change that improves performance | ||
title: "perf: " | ||
labels: performance | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what code needs to be changed and what the performance impact is going to be. Bonus point's if you can tie this directly to user experience. | ||
|
||
**Requirements** | ||
|
||
- [ ] There is no drop in test coverage. |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/refactor.md
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,14 @@ | ||
--- | ||
name: Refactor | ||
about: A code change that neither fixes a bug nor adds a feature | ||
title: "refactor: " | ||
labels: refactor | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what needs to be refactored and why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize. | ||
|
||
**Requirements** | ||
|
||
- [ ] There is no drop in test coverage. |
16 changes: 16 additions & 0 deletions
16
packages/academic_calendar/.github/ISSUE_TEMPLATE/revert.md
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,16 @@ | ||
--- | ||
name: Revert Commit | ||
about: Reverts a previous commit | ||
title: "revert: " | ||
labels: revert | ||
--- | ||
|
||
**Description** | ||
|
||
Provide a link to a PR/Commit that you are looking to revert and why. | ||
|
||
**Requirements** | ||
|
||
- [ ] Change has been reverted | ||
- [ ] No change in test coverage has happened | ||
- [ ] A new ticket is created for any follow on work that needs to happen |
14 changes: 14 additions & 0 deletions
14
packages/academic_calendar/.github/ISSUE_TEMPLATE/style.md
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,14 @@ | ||
--- | ||
name: Style Changes | ||
about: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc) | ||
title: "style: " | ||
labels: style | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what you are looking to change and why. | ||
|
||
**Requirements** | ||
|
||
- [ ] There is no drop in test coverage. |
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,14 @@ | ||
--- | ||
name: Test | ||
about: Adding missing tests or correcting existing tests | ||
title: "test: " | ||
labels: test | ||
--- | ||
|
||
**Description** | ||
|
||
List out the tests that need to be added or changed. Please also include any information as to why this was not covered in the past. | ||
|
||
**Requirements** | ||
|
||
- [ ] There is no drop in test coverage. |
27 changes: 27 additions & 0 deletions
27
packages/academic_calendar/.github/PULL_REQUEST_TEMPLATE.md
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,27 @@ | ||
<!-- | ||
Thanks for contributing! | ||
Provide a description of your changes below and a general summary in the title | ||
Please look at the following checklist to ensure that your PR can be accepted quickly: | ||
--> | ||
|
||
## Status | ||
|
||
**READY/IN DEVELOPMENT/HOLD** | ||
|
||
## Description | ||
|
||
<!--- Describe your changes in detail --> | ||
|
||
## Type of Change | ||
|
||
<!--- Put an `x` in all the boxes that apply: --> | ||
|
||
- [ ] ✨ New feature (non-breaking change which adds functionality) | ||
- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue) | ||
- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change) | ||
- [ ] 🧹 Code refactor | ||
- [ ] ✅ Build configuration change | ||
- [ ] 📝 Documentation | ||
- [ ] 🗑️ Chore |
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,21 @@ | ||
{ | ||
"version": "0.2", | ||
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", | ||
"dictionaries": ["vgv_allowed", "vgv_forbidden"], | ||
"dictionaryDefinitions": [ | ||
{ | ||
"name": "vgv_allowed", | ||
"path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/allowed.txt", | ||
"description": "Allowed VGV Spellings" | ||
}, | ||
{ | ||
"name": "vgv_forbidden", | ||
"path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/forbidden.txt", | ||
"description": "Forbidden VGV Spellings" | ||
} | ||
], | ||
"useGitignore": true, | ||
"words": [ | ||
"academic_calendar" | ||
] | ||
} |
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,11 @@ | ||
version: 2 | ||
enable-beta-ecosystems: true | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
- package-ecosystem: "pub" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
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,27 @@ | ||
name: ci | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
semantic_pull_request: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1 | ||
|
||
spell-check: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1 | ||
with: | ||
includes: "**/*.md" | ||
modified_files_only: false | ||
|
||
build: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1 | ||
|
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,7 @@ | ||
# See https://www.dartlang.org/guides/libraries/private-files | ||
|
||
# Files and directories created by pub | ||
.dart_tool/ | ||
.packages | ||
build/ | ||
pubspec.lock |
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,62 @@ | ||
# Academic Calendar | ||
|
||
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] | ||
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason) | ||
[![License: MIT][license_badge]][license_link] | ||
|
||
A Very Good Project created by Very Good CLI. | ||
|
||
## Installation 💻 | ||
|
||
**❗ In order to start using Academic Calendar you must have the [Dart SDK][dart_install_link] installed on your machine.** | ||
|
||
Install via `dart pub add`: | ||
|
||
```sh | ||
dart pub add academic_calendar | ||
``` | ||
|
||
--- | ||
|
||
## Continuous Integration 🤖 | ||
|
||
Academic Calendar comes with a built-in [GitHub Actions workflow][github_actions_link] powered by [Very Good Workflows][very_good_workflows_link] but you can also add your preferred CI/CD solution. | ||
|
||
Out of the box, on each pull request and push, the CI `formats`, `lints`, and `tests` the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses [Very Good Analysis][very_good_analysis_link] for a strict set of analysis options used by our team. Code coverage is enforced using the [Very Good Workflows][very_good_coverage_link]. | ||
|
||
--- | ||
|
||
## Running Tests 🧪 | ||
|
||
To run all unit tests: | ||
|
||
```sh | ||
dart pub global activate coverage 1.2.0 | ||
dart test --coverage=coverage | ||
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info | ||
``` | ||
|
||
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov). | ||
|
||
```sh | ||
# Generate Coverage Report | ||
genhtml coverage/lcov.info -o coverage/ | ||
|
||
# Open Coverage Report | ||
open coverage/index.html | ||
``` | ||
|
||
[dart_install_link]: https://dart.dev/get-dart | ||
[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions | ||
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg | ||
[license_link]: https://opensource.org/licenses/MIT | ||
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only | ||
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only | ||
[mason_link]: https://github.com/felangel/mason | ||
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg | ||
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis | ||
[very_good_coverage_link]: https://github.com/marketplace/actions/very-good-coverage | ||
[very_good_ventures_link]: https://verygood.ventures | ||
[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only | ||
[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only | ||
[very_good_workflows_link]: https://github.com/VeryGoodOpenSource/very_good_workflows |
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 @@ | ||
include: package:very_good_analysis/analysis_options.5.1.0.yaml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,4 @@ | ||
/// A library with a set of functions to work with academic calendars. | ||
library academic_calendar; | ||
|
||
export 'src/academic_calendar.dart'; |
Oops, something went wrong.