Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (43 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

53 lines (43 loc) · 1.63 KB

Contributing to Belajarpython.com

Thank you for contributing.

Development Setup

Prerequisite: use Node.js 20.x.

  1. Install dependencies: 
    npm ci
  2. Start local development: 
    npm run dev
  3. Build the site: 
    npm run build
  4. Run validation checks: 
    npm run check

Content Guidelines

  • Keep tutorials clear, practical, and beginner-friendly.
  • Use consistent front matter (layout, lang, title, description, order, permalink).
  • Place tutorials under content/{en|uz}/tutorial/{basic|intermediate|advanced}/.
  • Keep DSA/algorithm pages under content/{en|uz}/{data-structures|algorithms}/ with dsa.njk layout and locale-consistent permalinks.
  • Use locale-first permalinks only:
    • English tutorial: /en/tutorial/{slug}/
    • Uzbek tutorial: /uz/tutorial/{slug}/
  • Use lang: en or lang: uz in localized pages/tutorials.
  • Wrap code-related prose tokens in inline code (for example: if, else, for, while, True, False, None, {}).
  • Add descriptive image alt text.
  • Verify internal links and JSON-LD output with npm run check.
  • Keep runnable Python examples self-contained; snippets that need external setup should include # non-runnable: requires external environment/setup as the first line.

Pull Request Checklist

  • npm run build succeeds.
  • npm run check succeeds.
  • New/updated content has working links and metadata.
  • Changes are scoped to the issue/task.

Reporting Issues

Please open an issue with:

  • A clear description of the problem.
  • Steps to reproduce (if applicable).
  • Expected and actual behavior.