Skip to content

Commit

Permalink
Generate Dokka documentation for the Kotlin API. Update documentation…
Browse files Browse the repository at this point in the history
…. Introduce GitHub issue templates. Introduce security policy. Update changelog.
  • Loading branch information
NiallScott committed Oct 10, 2023
1 parent ad89211 commit 9c140e6
Show file tree
Hide file tree
Showing 11 changed files with 435 additions and 160 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,25 @@
---
name: Bug report
about: Report an issue, such as abnormal behaviour or a crash
title: "[Feature name] Short description of the issue"
labels: bug
assignees: ''
---

**Description of issue**
Full description of the issue here.

**Expected behaviour**
Describe what you expected to happen here.

**Library version:** The version of the library the issue occurred on.

**Java environment:** As much detail as possible concerning your Java environment.

**Operating system:** As much detail as possible concerning your operating system and version.

**Integrating language:** The language you are using to integrate with this library, e.g. Java or Kotlin.

Please check you are using the latest version of the library as your issue may have already been solved.

Please ensure you give as much detail as possible as this helps in tracing down the issue quickly.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an improvement or new feature for this library
title: Short description of request
labels: enhancement
assignees: ''
---

**Description of enhancement**
Please describe your enhancement here with as much detail as possible.

**Design suggestions**
If applicable, describe how you think your enhancement would be implemented.

**Additional context**
Any other relevant information that would help should go here.
1 change: 1 addition & 0 deletions .github/workflows/push-and-pull-request.yml
Expand Up @@ -21,3 +21,4 @@ jobs:
:api:test
:api-kt:test
:api:javadoc
:api-kt:dokkaHtml
19 changes: 10 additions & 9 deletions CHANGELOG.md
@@ -1,15 +1,16 @@
Changelog
=========
# Changelog

1.2.0
-----
## 1.3.0
- Introduced Kotlin version of the library, making use of Kotlin-Serialization and Kotlin-Coroutines.
- Updated library project build scripts.
- No changes to the public interface of the Java library.

## 1.2.0
- Added constants returned by the API for comparison.

1.1.0
-----
## 1.1.0
- Fixed incorrect JSON object structure for `getBusTimes`.
- Other fixes to make sure the API calls and objects reflect the latest developer guide from INEO.

1.0.0
-----
Initial release.
## 1.0.0
Initial release.

0 comments on commit 9c140e6

Please sign in to comment.