Contribution Guide

Contribution Guide

Welcome Contributors

Thank you for your interest in the RailWise Knowledge Base! We welcome all forms of contributions, including but not limited to:

• Documentation: Technical documents, tutorials, case studies
• Tools: Open source tools, scripts, plugins
• Feedback: Bug reports, feature suggestions
• Experience: Project experience, best practices
• Translation: Multi-language document translation

Contribution Methods

Method 1: GitHub Pull Request (Recommended)

For contributors with GitHub experience.

Steps:

1. Fork Repository

   # Visit https://github.com/railwise/knowledge-base
   # Click the Fork button

2. Clone Repository

   git clone https://github.com/your-username/knowledge-base.git
   cd knowledge-base

3. Create Branch

   git checkout -b contrib/{doc-type}-{brief-description}

4. Write Document

   • Follow Quality Standards
   • Use Markdown format
   • Include complete YAML Frontmatter

5. Submit Changes

   git add .
   git commit -m "docs: add {document title}"
   git push origin contrib/{branch-name}

6. Create Pull Request

Method 2: Online Editor

For contributors unfamiliar with Git.

Steps:

1. Visit RailWise Knowledge Base Editor
2. Log in with GitHub account
3. Click “New Document”
4. Edit document content online
5. Submit for review

Method 3: Email Submission

For contributors unable to use GitHub.

Steps:

1. Download document template
2. Write document according to template
3. Send to: contribute@railwise.cn
4. Email subject format: [Submission] {Document Title} - {Author Name}

Content Requirements

Document Types

Type	Description	Example
Technical Document	Product usage guide, API document	CLI command reference
Tutorial	Detailed operation steps	TSM deployment tutorial
Case Study	Project experience sharing	Deep foundation pit monitoring case
Standard Interpretation	National standard AI interpretation	GB 50497 interpretation
Tool	Open source tool usage description	Data processing script
Translation	Multi-language document	English version document

Content Standards

All submitted documents must include:

1. YAML Frontmatter

   ---
   title: "Document Title"
   description: "Document Description"
   category_primary: "Main Category"
   category_secondary: "Sub Category"
   tags: ["tag1", "tag2"]
   author: "Author Name"
   date: "YYYY-MM-DD"
   version: "1.0"
   ---

2. Structured Content

   • Use Markdown format
   • Clear heading hierarchy (H1-H4)
   • Appropriate use of tables, code blocks, callouts

3. Related Document Links

   • Use relative paths when referencing other documents
   • Format: [Document Name](../path/document-name.md)

4. AI Semantic Tags

   • Add AI semantic tag comments at the end of the document
   • Format: <!-- AI Semantic Tags: tag1, tag2 -->

Review Process

After submission, documents enter the review process:

Submission → Automatic Check → Initial Review → Technical Review → Quality Review → Publication

Review cycle is typically 3-7 business days.

Reward Mechanism

After submission is accepted, you will receive:

• Points: 50-500 points based on document quality
• Badge: Contributor badge on profile page
• Attribution: Author information displayed on document page
• Gifts: Annual outstanding contributors receive RailWise merchandise

Detailed reward rules: Points and Incentive System

Contact

• Contribution Inquiry: contribute@railwise.cn
• Technical Support: support@railwise.cn
• Community Discussion: GitHub Discussions

---

RailWise · Smart Monitoring — Engineering Surveying and Safety Monitoring Digital Solutions