Skip to content

Commit 28de10d

Browse files
Update contributing guidelines
1 parent 826c852 commit 28de10d

File tree

3 files changed

+44
-5
lines changed

3 files changed

+44
-5
lines changed

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.7.0] - 2022-05-18
914
### Added
1015
* New languages available: Indonesian (`'id'`) and Turkish (`'tr'`). Add language code constants and tests.
@@ -165,6 +170,7 @@ Version increased to avoid conflicts with old packages on PyPI.
165170
Initial version.
166171

167172

173+
[Unreleased]: https://github.com/DeepLcom/deepl-python/compare/v1.7.0...HEAD
168174
[1.7.0]: https://github.com/DeepLcom/deepl-python/compare/v1.6.0...v1.7.0
169175
[1.6.0]: https://github.com/DeepLcom/deepl-python/compare/v1.5.1...v1.6.0
170176
[1.5.1]: https://github.com/DeepLcom/deepl-python/compare/v1.5.0...v1.5.1

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-python/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 [[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-python/issues

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -500,8 +500,8 @@ feature, please open an [issue][issues].
500500

501501
## Development
502502

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

506506
### Tests
507507

0 commit comments

Comments
 (0)