> For the complete documentation index, see [llms.txt](https://bpio.gitbook.io/piman/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bpio.gitbook.io/piman/dev-guide.md).

# 成為貢獻者，一起開發 Piman

感謝您對 Piman 有興趣！

Piman 的目標是盡量讓通用設計的理念「Design for all」落實在網頁設計上。 

在成為開發夥伴之前，請您先花一點點時間閱讀以下項目：

*  Issue
  * 請先搜尋 Github 上有沒有相關 issue
  * 有的話，可以嘗試解解看
  * 沒有的話可以開一個新 issue
  * 並且使用我們設定的 label
* Pull Request
  * fork repo
  * clone fork
  * commit 訊息
    * feat：新功能
    * fix：修正 bug
    * refactor：coding style, project arch, 文件
    * revert：revert commit
    * unittest
  * DO NOT PR dist 資料夾
  * rebase
  * PR 到 dev 分支
* Tag
  * release format：x.x.x-{y}.x


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://bpio.gitbook.io/piman/dev-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.