|
1 |
| -# How to contribute |
| 1 | +# Notice to external contributors |
2 | 2 |
|
3 |
| -First and foremost, thank you for considering contributing to the db-java-dialects project! |
4 |
| -Your assistance is highly valued by the YDB community. |
| 3 | +## Common |
5 | 4 |
|
6 |
| -This document provides guidelines for contributing to the project |
7 |
| -and suggests ways to propose improvements, report bugs, and submit pull requests. |
| 5 | +YDB is a free and open project and we appreciate to receive contributions from our community. |
8 | 6 |
|
9 |
| -## Reporting Issues |
| 7 | +## Contributing code changes |
10 | 8 |
|
11 |
| -Before reporting an issue: |
12 |
| -- Use the GitHub issue search to check if the issue has already been reported. |
13 |
| -- If the issue is a bug, include a clear description of the problem with as much relevant information as possible (e.g., versions of libs). |
| 9 | +If you would like to contribute a new feature or a bug fix, please discuss your idea first on the GitHub issue. |
| 10 | +If there is no issue for your idea, please open one. It may be that somebody is already working on it, |
| 11 | +or that there are some complex obstacles that you should know about before starting the implementation. |
| 12 | +Usually there are several ways to fix a problem and it is important to find the right approach before spending time on a PR |
| 13 | +that cannot be merged. |
14 | 14 |
|
15 |
| -To report a new issue, please follow these steps: |
| 15 | +## Provide a contribution |
16 | 16 |
|
17 |
| -- Go to the "Issues" tab in the "db-java-dialects" repository. |
18 |
| -- Click on the "New Issue" button and choose the appropriate type of issue (error report or feature request). |
19 |
| -- Fill in the required details according to the selected template. |
20 |
| -- Assign the relevant tags. |
| 17 | +To make a contribution you should submit a pull request. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged. |
21 | 18 |
|
22 |
| -## Legal Info |
| 19 | +## Other questions |
23 | 20 |
|
24 |
| -In order for us (YANDEX LLC) to accept patches and other contributions from you, |
25 |
| -you will have to adopt our Yandex Contributor License Agreement (the “**CLA**”). |
26 |
| -The current version of the CLA you may find here: |
27 |
| -1) https://yandex.ru/legal/cla/?lang=en (in English) and |
28 |
| -2) https://yandex.ru/legal/cla/?lang=ru (in Russian). |
| 21 | +If you have any questions, please mail us at [email protected]. |
0 commit comments