Skip to content

Commit bed582e

Browse files
Initial implementation, including text and document translation
1 parent 3c01d10 commit bed582e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+4612
-1
lines changed

.gitignore

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
*.swp
2+
.classpath
3+
.project
4+
.settings
5+
tags
6+
target
7+
.idea
8+
*.iml
9+
.DS_Store
10+
11+
# Gradle files
12+
.gradle/*
13+
build/
14+
out/*
15+
16+
# compiler output
17+
bin/

.gitlab-ci.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Note: This GitLab CI configuration is used for internal testing, users can ignore it.
2+
include:
3+
- project: '${CI_PROJECT_NAMESPACE}/ci-libs-for-client-libraries'
4+
file:
5+
- '/${CI_PROJECT_NAME}/.gitlab-ci.yml'
6+
7+
# Global --------------------------
8+
9+
image: openjdk:latest
10+
11+
variables:
12+
GRADLE_OPTS: "-Dorg.gradle.daemon=false"
13+
14+
stages:
15+
- check
16+
- build
17+
- test
18+
- publish
19+
20+
before_script:
21+
- GRADLE_USER_HOME="$(pwd)/.gradle"
22+
- export GRADLE_USER_HOME
23+
24+
# stage: check ----------------------
25+
26+
spotless:
27+
stage: check
28+
script: ./gradlew spotlessCheck
29+
30+
# stage: build ----------------------
31+
32+
build:
33+
stage: build
34+
script:
35+
- ./gradlew assemble
36+
artifacts:
37+
paths:
38+
- deepl-java/build/
39+
40+
# stage: test -------------------------
41+
42+
test:
43+
stage: test
44+
extends: .test
45+
parallel:
46+
matrix:
47+
- DOCKER_IMAGE: "openjdk:18"
48+
- DOCKER_IMAGE: "openjdk:8"
49+
USE_MOCK_SERVER: "use mock server"
50+
- DOCKER_IMAGE: "openjdk:11"
51+
USE_MOCK_SERVER: "use mock server"
52+
- DOCKER_IMAGE: "openjdk:17"
53+
USE_MOCK_SERVER: "use mock server"
54+
- DOCKER_IMAGE: "openjdk:18"
55+
USE_MOCK_SERVER: "use mock server"
56+
- DOCKER_IMAGE: "openjdk:19"
57+
USE_MOCK_SERVER: "use mock server"
58+
- DOCKER_IMAGE: "openjdk:20"
59+
USE_MOCK_SERVER: "use mock server"
60+
image: ${DOCKER_IMAGE}
61+
script:
62+
- >
63+
if [[ ! -z "${USE_MOCK_SERVER}" ]]; then
64+
echo "Using mock server"
65+
export DEEPL_SERVER_URL=http://deepl-mock:3000
66+
export DEEPL_MOCK_SERVER_PORT=3000
67+
export DEEPL_PROXY_URL=http://deepl-mock:3001
68+
export DEEPL_MOCK_PROXY_SERVER_PORT=3001
69+
fi
70+
- ./gradlew test
71+
artifacts:
72+
paths:
73+
- deepl-java/build/reports/tests/test
74+
reports:
75+
junit:
76+
- deepl-java/build/reports/tests/test/index.html
77+
when: always
78+
79+
# stage: publish -------------------------
80+
81+
publish:
82+
stage: publish
83+
extends: .publish
84+
dependencies:
85+
- build
86+
rules:
87+
- if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
88+
script:
89+
- ./gradlew publish
90+

CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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+
8+
## [0.1.0] - 2022-09-08
9+
Initial version.
10+
11+
12+
[0.1.0]: https://github.com/DeepLcom/deepl-java/releases/tag/v0.1.0

CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations
133+

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing guidelines
2+
3+
* [Code of Conduct](#code-of-conduct)
4+
* [Issues](#issues)
5+
* [Pull Requests](#pull-requests)
6+
7+
## Code of Conduct
8+
9+
This project has a [Code of Conduct](CODE_OF_CONDUCT.md) to which all
10+
contributors must adhere when participating in the project. Instances of
11+
abusive, harassing, or otherwise unacceptable behavior may be reported by
12+
contacting [[email protected]](mailto:[email protected]) and/or a
13+
project maintainer.
14+
15+
## Issues
16+
17+
If you experience problems using the library, or would like to request a new
18+
feature, please open an [issue][issues].
19+
20+
Please provide as much context as possible when you open an issue. The
21+
information you provide must be comprehensive enough for us to reproduce the
22+
issue.
23+
24+
## Pull Requests
25+
26+
You are welcome to contribute code and/or documentation in order to fix a bug or
27+
to implement a new feature. Before beginning work, you should create an issue
28+
describing the changes you plan to contribute, to avoid wasting or duplicating
29+
effort. We will then let you know whether we would accept the changes.
30+
31+
Contributions must be licensed under the same license as the project:
32+
[MIT License](LICENSE).
33+
34+
Currently automated testing is implemented internally at DeepL, however we plan
35+
to implement publicly visible testing soon.
36+
37+
[issues]: https://www.github.com/DeepLcom/deepl-java/issues

0 commit comments

Comments
 (0)