Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add Thai translation to CONTRIBUTING.md + TOC of README.md #125

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Contributing Guideline

\[ [ภาษาไทย](#แนวทางการสมทบงาน) \]

1. First, and most importantly, make sure you read the [README.md file](README.md).
2. Read the [issues](https://github.com/wevisdemo/parliament-watch/issues) carefully, comment on the issue you want to work on, and we'll assign it to you.
3. Feels free to open a new issue, if you found a bug or have some idea.
Expand All @@ -10,3 +12,24 @@
8. Open-source maintenance is not everything we do, but we'll try to be as responsive as possible.

Thanks for contributing, and happy coding! 🎉

## แนวทางการสมทบงาน

1. เรื่องแรกเลย อ่าน [README.md file](README.md) ก่อน อันนี้สำคัญที่สุด
2. อ่านรายการ [issue](https://github.com/wevisdemo/parliament-watch/issues)
อย่างระมัดระวัง;
ตอบความเห็นใน issue ที่คุณต้องการลงมือปรับปรุง;
จากนั้นเราจะมอบหมาย issue ดังกล่าวให้คุณ
3. เปิด issue ใหม่ได้ทันที ถ้าคุณพบบั๊ก จุดผิดพลาด หรือมีไอเดียใดๆ
4. ถ้าคุณไม่มีสิทธิในการเขียน repo นี้โดยตรง ให้ fork โครงการ
และ checkout จาก branch ที่ระบุไว้ใน issue
5. เปิด PR (pull request) โดยใช้ชื่อเดียวกับ issue
และกำหนด branch ตามที่ระบุไว้ใน issue;
ผู้ดูแลจะตรวจทานงานของคุณ และอาจให้ความเห็นกับคุณก่อนจะผนวกโค้ด
6. ถ้างานของคุณยังไม่พร้อมให้ตรวจทาน เพิ่ม "[WIP]" ไว้ที่ด้านหน้าสุดของชื่อ PR
7. สอบถาม-แลกเปลี่ยนใน issue หรือใน PR ของ GitHub ได้ตามสบาย
ใช้ภาษาไทยหรืออังกฤษได้ตามสะดวก
8. การดูแลโครงการโอเพนซอร์สไม่ใช่เรื่องเดียวที่เราทำ
แต่เราจะพยายามตอบกลับให้เร็วที่สุดเท่าที่จะทำได้

ขอบคุณที่ร่วมทำงานสมทบ ขอให้มีความสุขกับการโค้ด! 🎉
74 changes: 46 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 👀 Parliament Watch

Citizens are watching
Citizens are watching ประชาชมอยู่นะ

> **Hacktoberfest 2024 is here!** every constibutor will receive a Parliament Watch sticker ✨ [see more](https://www.facebook.com/wevisdemo/posts/pfbid06t4zjUoG2noQW1pow9PiN2wmVQpUTHUSyE44SZcpP7bAaRRGaQy9JU1iWpUnVQAnl)

Expand All @@ -11,26 +11,27 @@ Citizens are watching
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [⭐ Goal](#-goal)
- [🌎 Environments](#-environments)
- [🍱 Tech Stack](#-tech-stack)
- [Front-end](#front-end)
- [Local development](#local-development)
- [Deployment pipeline](#deployment-pipeline)
- [🪄 Useful Commands](#-useful-commands)
- [Start SvelteKit](#start-sveltekit)
- [Start Histoire](#start-histoire)
- [Generate a new component](#generate-a-new-component)
- [Log](#log)
- [🗃️ Directory Structure](#-directory-structure)
- [🍭 Design System](#-design-system)
- [Typography](#typography)
- [Colors](#colors)
- [Components](#components)
- [Icons](#icons)
- [💾 Data Pipeline](#-data-pipeline)
- [🤝 Contributing Guideline](#-contributing-guideline)
- [📜 License and Terms of Use](#-license-and-terms-of-use)
- [⭐ Goal](#-goal) เป้าหมาย
- [🌎 Environments](#-environments) สภาพแวดล้อม
- [🍱 Tech Stack](#-tech-stack) ชุดเทคโนโลยี
- [Front-end](#front-end) หน้าบ้าน
- [Local development](#local-development) พัฒนาที่เครื่องส่วนท้องถิ่น
- [Deployment pipeline](#deployment-pipeline) สายพานติดตั้ง
- [🪄 Useful Commands](#-useful-commands) คำสั่งที่มีประโยชน์
- [Start SvelteKit](#start-sveltekit) สตาร์ต SvelteKit
- [Start Histoire](#start-histoire) สตาร์ต Histoire
- [Generate a new component](#generate-a-new-component) สร้างคอมโพเนนต์ใหม่

- [Log](#log) บันทึกเหตุการณ์
- [🗃️ Directory Structure](#-directory-structure) โครงสร้างไดเรกทอรี
- [🍭 Design System](#-design-system) ระบบการออกแบบ
- [Typography](#typography) ตัวพิมพ์
- [Colors](#colors) สี
- [Components](#components) คอมโพเนนต์
- [Icons](#icons) ไอคอน
- [💾 Data Pipeline](#-data-pipeline) สายพานข้อมูล
- [🤝 Contributing Guideline](#-contributing-guideline) แนวทางการสมทบงาน
- [📜 License and Terms of Use](#-license-and-terms-of-use) สัญญาอนุญาตและเงื่อนไขการใช้งาน

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -40,12 +41,22 @@ We want to record and visualise the Thai parliament information including politi

This project can be seen as a renovated combination of [They Work for Us](https://github.com/wevisdemo/they-work-for-us), [Law Watch](https://github.com/wevisdemo/law-watch), and [Promise Tracker](https://github.com/wevisdemo/promise-tracker) which aim to support several election era.

เราต้องการบันทึกข้อมูลของรัฐสภาไทยและวาดมันออกมาให้เห็นเป็นภาพ
ข้อมูลเหล่านั้นรวมถึง ข้อมูลนักการเมือง ข้อมูลการประชุม ร่างกฎหมาย
กระบวนการลงคะแนน และสัญญาที่ให้ไว้

โครงการนี้จะว่าไปก็เหมือนกับการรวมร่างโครงการ
[They Work for Us](https://github.com/wevisdemo/they-work-for-us),
[Law Watch](https://github.com/wevisdemo/law-watch), และ
[Promise Tracker](https://github.com/wevisdemo/promise-tracker)
จากการเลือกตั้งครั้งก่อนๆ และปรับปรุงให้ดีขึ้น

## 🌎 Environments

| Name | URL |
| --------------------- | ---------------------------------- |
| Production | https://parliamentwatch.wevis.info |
| Staging (main branch) | https://parliament-watch.pages.dev |
| Name | URL |
| --------------------- | ------__---------------------------- |
| Production | <https://parliamentwatch.wevis.info> |
| Staging (main branch) | <https://parliament-watch.pages.dev> |

## 🍱 Tech Stack

Expand All @@ -62,15 +73,22 @@ This project can be seen as a renovated combination of [They Work for Us](https:
- [Yarn v1](https://classic.yarnpkg.com) as a package manager
- Husky and lint-staged will
- Lint (ESLint) and format (Prettier) code before commiting
- Validate that commit message is align with [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) using commitlint
- Validate that commit message is align with [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) using [commitlint](https://github.com/conventional-changelog/commitlint)
- Run svelte-check before pushing
- For VSCode user, format on save is enabled and [prettier-vscode extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) will be recommended when open the project.
- [Hygen](http://www.hygen.io) for a code generation

### Deployment pipeline

- **Staging**: Each push will trigger the [Github Actions Workflow](.github/workflows/staging.yml) to build the site, upload the build artifact, and deploy on [Cloudflare Pages](https://pages.cloudflare.com). Can also be triggered manually.
- **Production**: The [Github Actions Workflow](.github/workflows/staging.yml) can only be manually triggered to download the latest build artifact and upload to our server through SSH.
- **Staging**: Each push will trigger the [Github Actions Workflow](.github/workflows/staging.yml) to build the site, upload the build artifact, and deploy on [Cloudflare Pages](https://pages.cloudflare.com). Can also be triggered manually.
การพุชแต่ละครั้งจะกระตุ้นให้
[Github Actions Workflow](.github/workflows/staging.yml)
ทำงานเพื่อสร้างเว็บไซต์ อัปโหลดส่วนประกอบของเว็บไซต์ที่สร้างเสร็จ
และติดตั้งที่ Cloudflare Pages เวิร์กโฟลว์นี้คนสามารถสั่งให้ทำงานได้
- **Production**: The [Github Actions Workflow](.github/workflows/staging.yml) can only be manually triggered to download the latest build artifact and upload to our server through SSH.
เวิร์กโฟลว์นี้จะทำงานก็ต่อเมื่อมีคนสั่งเท่านั้น
มันจะดาวน์โหลดส่วนประกอบของเว็บไซต์ที่ถูกสร้างล่าสุด
และอัปโหลดไปที่เซิร์ฟเวอร์ของเราผ่าน SSH

## 🪄 Useful Commands

Expand Down