Skip to content

Commit 46c6b87

Browse files
authored
Improve contributing documentation (#1884)
1 parent 9d698e7 commit 46c6b87

File tree

1 file changed

+54
-17
lines changed

1 file changed

+54
-17
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,61 @@ ydb-go-sdk (and YDB also) is an open project, and you can contribute to it in ma
55
Thank you!
66

77
## Table of contents
8-
* [Legal Info](#legal-info)
9-
* [Technical Info](#technical-info)
10-
* [Using Dev Containers and GitHub Codespaces](#using-dev-containers-and-github-codespaces)
11-
+ [Quick Start with Dev Containers](#quick-start-with-dev-containers)
12-
+ [Using GitHub Codespaces](#using-github-codespaces)
13-
* [Instructions for checks code changes locally](#instructions-for-checks-code-changes-locally)
14-
+ [Prerequisites](#prerequisites)
15-
+ [Run linter checks](#run-linter-checks)
16-
+ [Run tests](#run-tests)
8+
- [How to contribute](#how-to-contribute)
9+
- [Table of contents](#table-of-contents)
10+
- [How You Can Help](#how-you-can-help)
11+
- [🔧 Work on Issues](#-work-on-issues)
12+
- [👀 Review Pull Requests](#-review-pull-requests)
13+
- [📚 Add Examples](#-add-examples)
14+
- [📝 Improve Documentation](#-improve-documentation)
15+
- [🧪 Test the SDK](#-test-the-sdk)
16+
- [Using Dev Containers and GitHub Codespaces](#using-dev-containers-and-github-codespaces)
17+
- [Quick Start with Dev Containers](#quick-start-with-dev-containers)
18+
- [Using GitHub Codespaces](#using-github-codespaces)
19+
- [Instructions for checks code changes locally](#instructions-for-checks-code-changes-locally)
20+
- [Prerequisites](#prerequisites)
21+
- [Run linter checks](#run-linter-checks)
22+
- [Run tests](#run-tests)
1723
- [Only unit tests](#only-unit-tests)
18-
- [All tests (include integration tests)](#all-tests)
19-
20-
## Technical Info
21-
22-
1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
23-
2. Fork the repository <https://github.com/ydb-platform/ydb-go-sdk> on GitHub to start making your changes to the **master** branch (or branch off of it).
24-
3. Write a test which shows that the bug was fixed or that the feature works as expected.
25-
4. Send a pull request and bug the maintainer until it gets merged and published.
24+
- [All tests](#all-tests)
25+
26+
## How You Can Help
27+
28+
There are many ways to contribute to the YDB Go SDK project, regardless of your experience level:
29+
30+
### 🔧 Work on Issues
31+
- Browse our [open issues](https://github.com/ydb-platform/ydb-go-sdk/issues) and pick one that interests you
32+
- Look for issues labeled `good first issue` or `student project` or even `30min` if you're new to the project
33+
- Comment on the issue to let others know you're working on it
34+
- Submit a Pull Request with your solution
35+
36+
### 👀 Review Pull Requests
37+
- Help review [open pull requests](https://github.com/ydb-platform/ydb-go-sdk/pulls)
38+
- Test proposed changes locally
39+
- Provide constructive feedback on code quality, performance, and design
40+
- Share your expertise to help improve submissions
41+
42+
### 📚 Add Examples
43+
- Create practical examples demonstrating SDK features
44+
- Add code samples to the `/examples` directory
45+
- Show real-world use cases and best practices
46+
- Help others understand how to use different SDK capabilities
47+
48+
### 📝 Improve Documentation
49+
- Document undocumented functions and methods
50+
- Improve existing documentation clarity
51+
- Add missing godoc comments
52+
- Create tutorials or guides for common tasks
53+
- Fix typos and grammatical errors
54+
55+
### 🧪 Test the SDK
56+
- Test the SDK in different environments and scenarios
57+
- Report bugs with detailed reproduction steps
58+
- Verify fixes for reported issues
59+
- Help improve test coverage by writing unit or integration tests
60+
- Test compatibility with different YDB versions
61+
62+
Every contribution, no matter how small, helps make the YDB Go SDK better for everyone. Thank you for your support!
2663

2764
## Using Dev Containers and GitHub Codespaces
2865

0 commit comments

Comments
 (0)