IvorySQL Documentation Co-construction Plan Phase I! Submit PRs/Issues to Win Beats Headphones, Mechanical Keyboards, Books, and More!
Documentation is a vital component of open-source projects. Well-structured, detailed, accurate, and easy-to-understand documentation helps users get started more easily, and most issues encountered during use can be resolved by reading the documentation. In the world of open-source databases, a complete and accurate set of documentation is not only a technical compass but also the cornerstone of community growth.
As an open-source database based on PostgreSQL, IvorySQL has always been committed to providing a superior user experience. However, with continuous feature iterations and increasing tasks, IvorySQL documentation still needs further improvement. To make the documentation more comprehensive and user-friendly while stimulating community vitality, we have decided to open the documentation update tasks to the entire community and encourage participation through generous rewards!
The first phase of the IvorySQL Documentation Co-construction Plan is now officially live! This phase will last for 3 months, focusing specifically on adding new documentation content. We sincerely invite you to join us in optimizing the document structure, filling in missing directories, and winning rewards through actual contributions. In the future, we will continue to launch subsequent phases to make co-construction a regular part of the IvorySQL community.
Event Period
- Start Date: September 23, 2025
- End Date: December 23, 2026
Event Tasks
- Write new documentation (including both Chinese and English versions) and submit a PR
- Provide suggestions for the current documentation structure, such as new documents needed or directory adjustments (via issue)
- Verify and check existing documentation; if errors are found, submit modification suggestions (via issue) or direct modifications (via PR)
How to Participate
- Method 1: Submit a PR to complete tasks in the task list (Recommended)
- In the event task list, select a task you are interested in and click it open.
- On the task's issue or pull request (PR), claim the task by adding the /assign command in the comments.
- Submit a PR to resolve the task, provide the related issue link in the PR description, label the PR by adding the /label ivorysql-docs-build command in the comments, and handle any review suggestions received for the PR.
- Method 2: Submit an issue to point out documentation problems, including but not limited to directory structure, accuracy, completeness, and clarity of content.
- Method 3: Submit a PR to fix any documentation issues.
- Method 4: Provide valuable comments on issues in the event task list.
Our optimized documentation structure is as follows (not yet updated to the official website): https://www.kdocs.cn/l/cg7tqtbtTXYB
Note: For PRs related to this event, please submit them to the master branch.
Event Rewards
Anyone who participates in this event, has their suggestions adopted, or has their PR merged will be considered as having made a contribution and will receive an IvorySQL Contributor Certificate.
In addition, there are great gifts to be won.
Participation Award: Anyone who submits an issue and provides any suggestions for the documentation structure or content that are ultimately adopted will receive a Participation Award—an IvorySQL Community Merchandise Bundle: IvorySQL T-shirt, Canvas bag, Fridge magnet, Eye mask, etc.
Additionally, based on final points, the following rewards are set:
- First Prize: Beats over-ear Bluetooth headphones
- Second Prize: Custom mechanical keyboard
- Third Prize: 3C certified power bank + 3-in-1 data cable
Furthermore, all participants will also receive a technical book.
Point Rules:
| Contribution Method | Points | Remarks |
|---|---|---|
| Claim a Task | 1 | 1 point per task claimed |
| Submit Task PR | 5 | 5 points per task PR submitted |
| Task PR Merged | 10 | 10 points per task PR merged |
| Submit Issue | 2 | 2 points per issue submitted |
| Issue Adopted | 4 | 4 points per issue adopted |
Note: The above applies only to the corresponding methods described in this event. All PR and issue submissions must be under the documentation repository.
FAQ
1. What are the requirements to participate in this event?
You need a GitHub account. Before submitting a PR, please read the IvorySQL Contribution Workflow Guide and sign the Contributor License Agreement (CLA). To help everyone write documentation more smoothly, please read the Documentation Syntax Reference.
- IvorySQL: https://github.com/IvorySQL/IvorySQL
- IvorySQL Docs: https://github.com/IvorySQL/ivorysql_docs
3. Will submitted issues and PRs definitely be adopted?
After contributors submit issues, we will review them. If they meet requirements, they will be adopted.
After contributors submit PRs, we will also review them and provide modification suggestions. Therefore, a new document may undergo multiple modifications until it meets the merge conditions.
4. How can I get help during the event?
You can open new issues on GitHub.
