Skip to content

Commit db3ec27

Browse files
SMadaniSMadani
committed
Add typical repo files
1 parent e8497e0 commit db3ec27

File tree

15 files changed

+553
-21
lines changed

15 files changed

+553
-21
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Request/Response**
27+
If applicable, please provide the request used and the response
28+
29+
**Java Version**
30+
- Version:
31+
32+
**Kotlin Version**
33+
- Version:
34+
35+
**Kotlin SDK Version**
36+
- Version:
37+
38+
**Proxy Server Used**
39+
* [ ] Yes
40+
* [ ] No
41+
42+
**Additional context/ Error Log**
43+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_Describe your changes here_
2+
3+
## Contribution Checklist
4+
* [ ] Unit tests!
5+
* [ ] Updated [CHANGELOG.md](CHANGELOG.md)
6+
* [ ] My name is in [CONTRIBUTORS.md](CONTRIBUTORS.md)

‎.github/workflows/build.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build Java CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
8+
permissions:
9+
actions: write
10+
checks: write
11+
contents: read
12+
deployments: read
13+
issues: write
14+
discussions: read
15+
packages: none
16+
pages: read
17+
pull-requests: write
18+
security-events: write
19+
statuses: write
20+
21+
jobs:
22+
build:
23+
runs-on: ${{ matrix.os }}
24+
strategy:
25+
fail-fast: false
26+
matrix:
27+
java: [8, 17, 22]
28+
os: [ubuntu-latest, macos-latest, windows-latest]
29+
steps:
30+
- name: Checkout the repo
31+
uses: actions/checkout@v4
32+
- name: Setup Java
33+
uses: actions/setup-java@v4
34+
with:
35+
distribution: 'zulu'
36+
java-version: ${{ matrix.java }}
37+
cache: maven
38+
- name: Compile with Maven
39+
run: mvn --batch-mode verify

‎.github/workflows/publish.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Publish to Central
2+
on:
3+
release:
4+
types: [published]
5+
6+
permissions:
7+
actions: write
8+
checks: write
9+
contents: write
10+
deployments: read
11+
issues: write
12+
discussions: write
13+
packages: write
14+
pages: write
15+
pull-requests: write
16+
security-events: write
17+
statuses: write
18+
19+
jobs:
20+
publish:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout the repo
24+
uses: actions/checkout@v4
25+
with:
26+
ref: ${{ github.event.release.target_commitish }}
27+
- name: Setup Java
28+
uses: actions/setup-java@v4
29+
with:
30+
java-version: 21
31+
distribution: 'temurin'
32+
cache: maven
33+
server-id: nexus-releases
34+
server-username: MAVEN_USERNAME
35+
server-password: MAVEN_PASSWORD
36+
gpg-private-key: ${{ secrets.SIGNING_KEY }}
37+
gpg-passphrase: MAVEN_GPG_PASSPHRASE
38+
- name: Publish package
39+
env:
40+
MAVEN_USERNAME: ${{ secrets.OSS_USERNAME }}
41+
MAVEN_PASSWORD: ${{ secrets.OSS_PASSWORD }}
42+
MAVEN_GPG_PASSPHRASE: ${{ secrets.SIGNING_PASSWORD }}
43+
run: mvn --no-transfer-progress --batch-mode deploy -P release-sign-artifacts

‎.gitignore

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,42 @@
1-
# Compiled class file
2-
*.class
1+
.gradle
2+
build/
3+
/build
4+
/target
5+
!gradle/wrapper/gradle-wrapper.jar
6+
!**/src/main/**/build/
7+
!**/src/test/**/build/
8+
dependency-reduced-pom.xml
39

4-
# Log file
5-
*.log
10+
### IntelliJ IDEA ###
11+
.idea/
12+
*.iws
13+
*.iml
14+
*.ipr
15+
out/
16+
!**/src/main/**/out/
17+
!**/src/test/**/out/
618

7-
# BlueJ files
8-
*.ctxt
19+
### Eclipse ###
20+
.apt_generated
21+
.classpath
22+
.factorypath
23+
.project
24+
.settings
25+
.springBeans
26+
.sts4-cache
27+
bin/
28+
!**/src/main/**/bin/
29+
!**/src/test/**/bin/
930

10-
# Mobile Tools for Java (J2ME)
11-
.mtj.tmp/
31+
### NetBeans ###
32+
/nbproject/private/
33+
/nbbuild/
34+
/dist/
35+
/nbdist/
36+
/.nb-gradle/
1237

13-
# Package Files #
14-
*.jar
15-
*.war
16-
*.nar
17-
*.ear
18-
*.zip
19-
*.tar.gz
20-
*.rar
38+
### VS Code ###
39+
.vscode/
2140

22-
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
23-
hs_err_pid*
24-
replay_pid*
41+
### Mac OS ###
42+
.DS_Store

‎.whitesource

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"settingsInheritedFrom": "Vonage/whitesource-config@main"
3+
}

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/).
6+
7+

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Getting Involved
2+
3+
Thanks for your interest in the project, we'd love to have you involved! Check out the sections below to find out more about what to do next...
4+
5+
## Opening an Issue
6+
7+
We always welcome issues, if you've seen something that isn't quite right or you have a suggestion for a new feature, please go ahead and open an issue in this project. Include as much information as you have, it really helps.
8+
9+
## Making a Code Change
10+
11+
We're always open to pull requests, but these should be small and clearly described so that we can understand what you're trying to do. Feel free to open an issue first and get some discussion going.
12+
13+
When you're ready to start coding, fork this repository to your own GitHub account and make your changes in a new branch. Once you're happy, open a pull request and explain what the change is and why you think we should include it in our project.

‎CONTRIBUTORS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Contributors
2+
3+
This is the vonage-java-sdk hall of fame! All contributors of source code, or
4+
documentation, or tests are eligible to be added to this list.
5+
6+
- Sina Madani ([@SMadani](https://github.com/SMadani))

‎README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
1-
# vonage-kotlin-sdk
2-
Vonage Server SDK for Kotlin. API support for SMS, Messages, Voice, Text-to-Speech, Numbers, Verify (2FA), Video and more.
1+
# Vonage Server SDK for Kotlin (JVM)
2+
3+
[![Maven Release](https://maven-badges.herokuapp.com/maven-central/com.vonage/kotlin-server-sdk/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.vonage/server-sdk)
4+
[![Build Status](https://github.com/Vonage/vonage-java-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/Vonage/vonage-java-sdk/actions/workflows/build.yml?query=workflow%3A"Build+Java+CI")
5+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
6+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.txt)
7+
8+
This SDK provides syntactic sugar for the [Vonage Java Server SDK](https://github.com/Vonage/vonage-java-sdk)
9+
to improve the user experience in Kotlin. It is therefore subject to the same requirements and capabilities.
10+

0 commit comments

Comments
 (0)