Skip to content

Commit feaa588

Browse files
committedJun 7, 2022
Update contributing guidelines
1 parent b73be73 commit feaa588

File tree

3 files changed

+46
-5
lines changed

3 files changed

+46
-5
lines changed
 

Diff for: ‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77

8+
## [Unreleased]
9+
### Changed
10+
* Update contributing guidelines, we can now accept Pull Requests.
11+
12+
813
## [1.2.0] - 2022-05-18
914
### Added
1015
* New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add
@@ -71,6 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7176
Initial release.
7277

7378

79+
[Unreleased]: https://github.com/DeepLcom/deepl-dotnet/compare/v1.2.0..HEAD
7480
[1.2.0]: https://github.com/DeepLcom/deepl-dotnet/compare/v1.1.0..v1.2.0
7581
[1.1.0]: https://github.com/DeepLcom/deepl-dotnet/compare/v1.0.5..v1.1.0
7682
[1.0.5]: https://github.com/DeepLcom/deepl-dotnet/compare/v1.0.4..v1.0.5

Diff for: ‎CONTRIBUTING.md

+36-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
1-
# Contribution guidelines
1+
# Contributing guidelines
22

3-
We are currently unable to accept Pull Requests. If you would like to suggest changes, please open an
4-
[issue](https://github.com/DeepLcom/deepl-dotnet/issues) instead.
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 [open-source@deepl.com](mailto:open-source@deepl.com) 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-dotnet/issues

Diff for: ‎README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -225,11 +225,11 @@ var translator = new Translator(authKey, options);
225225
## Issues
226226

227227
If you experience problems using the library, or would like to request a new feature, please open an
228-
[issue](https://www.github.com/DeepLcom/deepl-dotnet/issues).
228+
[issue][issues].
229229

230230
## Development
231231

232-
We are currently unable to accept Pull Requests. If you would like to suggest changes, please open an issue instead.
232+
We welcome Pull Requests, please read the [contributing guidelines](CONTRIBUTING.md).
233233

234234
### Tests
235235

@@ -244,3 +244,5 @@ only with the DeepL API or the mock-server and will be otherwise skipped. The te
244244
trigger server errors and test the client error-handling. To execute the tests using deepl-mock, run it in another
245245
terminal while executing the tests. Execute the tests using `dotnet test` with the `DEEPL_MOCK_SERVER_PORT` and
246246
`DEEPL_SERVER_URL` environment variables defined referring to the mock-server.
247+
248+
[issues]: https://www.github.com/DeepLcom/deepl-dotnet/issues

0 commit comments

Comments
 (0)
Please sign in to comment.