-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3e20c25
commit c459b84
Showing
3 changed files
with
20 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ This POS system is an open-source project, built bit by bit by various contribut | |
| - [Report Bugs](#how-to-report-bugs) | ||
| - [Propose New Features or Enhancements](#propose-new-features-or-enhancements) | ||
| - [Design and Interface Improvements](#adjust-the-user-interface) | ||
| - Respond to other people's [issues](https://evan361425.github.io/flutter-pos-system/issues) | ||
| - Respond to other people's [issues](https://github.com/evan361425/flutter-pos-system/issues) | ||
| - [Directly Write Code to Improve the POS System](#how-to-submit-code-changes) | ||
|
|
||
| Following the guidelines below will accelerate the development process. We also provide assistance, such as verifying issues, confirming improvements, and helping finalize pull requests (PRs). | ||
|
|
@@ -17,11 +17,13 @@ Following the guidelines below will accelerate the development process. We also | |
| ## Need Any Help? | ||
|
|
||
| If you encounter any issues not covered in this document, feel free to [email us](mailto:{{ site.social-network-links.email }}). Alternatively, you can [open an issue](https://evan361425.github.io/flutter-pos-system/issues/new) to ask your question. Others might have the same question, and we can solve it together 😬. | ||
| If you encounter any issues not covered in this document, feel free to [email us](mailto:[email protected]). | ||
| Alternatively, you can [open an issue](https://github.com/evan361425/flutter-pos-system/issues/new) to ask your question. Others might have the same question, and we can solve it together 😬. | ||
|
|
||
| ## Improve Documentation | ||
|
|
||
| If you find the documentation unclear or awkward while reading it, it likely needs improvement. First, check if there are any [related issues](https://evan361425.github.io/flutter-pos-system/labels/document). If not, please [submit a related issue](https://evan361425.github.io/flutter-pos-system/issues/new?assignees=&labels=&template=document.md&title=). | ||
| If you find the documentation unclear or awkward while reading it, it likely needs improvement. First, check if there are any [related issues](https://github.com/evan361425/flutter-pos-system/labels/document). | ||
| If not, please [submit a related issue](https://github.com/evan361425/flutter-pos-system/issues/new?assignees=&labels=&template=document.md&title=). | ||
|
|
||
| In addition, consider improving the documentation if you: | ||
|
|
||
|
|
@@ -35,7 +37,7 @@ When making [code changes](#how-to-submit-code-changes), remember to switch the | |
|
|
||
| ## How to Report Bugs | ||
|
|
||
| Found a bug? First, check if it has [already been reported](https://evan361425.github.io/flutter-pos-system/labels/bug). If not, please [submit a related issue](https://evan361425.github.io/flutter-pos-system/issues/new?assignees=&labels=&template=bug_report.md&title=). | ||
| Found a bug? First, check if it has [already been reported](https://github.com/evan361425/flutter-pos-system/labels/bug). If not, please [submit a related issue](https://github.com/evan361425/flutter-pos-system/issues/new?assignees=&labels=&template=bug_report.md&title=). | ||
|
|
||
| Here are some tips for writing a good bug report: | ||
|
|
||
|
|
@@ -54,11 +56,11 @@ If you have an idea for a feature that the POS system lacks, you're likely not a | |
|
|
||
| We welcome new feature proposals. Ensure the feature relates to the POS system and provide enough detail and feasibility. Explain the problem the feature aims to solve. | ||
|
|
||
| Thank you for helping improve the product. Start [creating a related issue](https://evan361425.github.io/flutter-pos-system/issues/new?assignees=&labels=&template=feature_request.md&title=)! | ||
| Thank you for helping improve the product. Start [creating a related issue](https://github.com/evan361425/flutter-pos-system/issues/new?assignees=&labels=&template=feature_request.md&title=)! | ||
|
|
||
| ## Adjust the User Interface | ||
|
|
||
| A good application needs a well-designed user interface, including both aesthetics and user experience. If you think a particular section needs a color change, let's try it! Please submit a [related issue](https://evan361425.github.io/flutter-pos-system/issues/new?assignees=&labels=&template=design.md&title=). | ||
| A good application needs a well-designed user interface, including both aesthetics and user experience. If you think a particular section needs a color change, let's try it! Please submit a [related issue](https://github.com/evan361425/flutter-pos-system/issues/new?assignees=&labels=&template=design.md&title=). | ||
|
|
||
| Consider the following: | ||
|
|
||
|
|
@@ -68,7 +70,7 @@ Consider the following: | |
|
|
||
| ## First-Time Contribution | ||
|
|
||
| We're delighted you want to contribute. If you're unsure where to start, check the [good first issue](https://evan361425.github.io/flutter-pos-system/issues?q=is%3Aissue+label%3A%22good+first+issue%22) label for suitable issues. Also, the [help wanted](https://evan361425.github.io/flutter-pos-system/issues?q=is%3Aissue+label%3A%22help+wanted%22) label is a good place to find tasks needing assistance. | ||
| We're delighted you want to contribute. If you're unsure where to start, check the [good first issue](https://github.com/evan361425/flutter-pos-system/issues?q=is%3Aissue+label%3A%22good+first+issue%22) label for suitable issues. Also, the [help wanted](https://github.com/evan361425/flutter-pos-system/issues?q=is%3Aissue+label%3A%22help+wanted%22) label is a good place to find tasks needing assistance. | ||
|
|
||
| - Good first issues usually involve minor code changes and a unit test. | ||
| - Help wanted issues might require more skill and experience but are areas needing help. | ||
|
|
@@ -88,7 +90,7 @@ Here are some guidelines for submitting code changes: | |
|
|
||
| Steps for code changes: | ||
|
|
||
| - [Fork](https://evan361425.github.io/flutter-pos-system/fork) and clone the project. | ||
| - [Fork](https://github.com/evan361425/flutter-pos-system/fork) and clone the project. | ||
| - Install necessary dependencies: `flutter pub get`. | ||
| - Install helper tools: `flutter run build_runner build`. | ||
| - Ensure local tests pass: `flutter test`. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ | |
| - [回報程式害蟲](#如何回報程式害蟲) | ||
| - [提出新功能或改善功能](#提出新功能或改善功能) | ||
| - [設計外觀和整體架構](#調整使用者介面) | ||
| - 透過留言回應其他人的 [issue]({{ site.github.repository_url }}/issues) | ||
| - 透過留言回應其他人的 [issue](https://github.com/evan361425/flutter-pos-system//issues) | ||
| - [直接撰寫程式碼改善 POS 系統](#怎麼提出程式碼上的異動) | ||
|
|
||
| 遵守以下的準則，會加速整個系統開發的流程和進度。當然，我們也會提供相應的幫助，如：確認 issue 的定位、確認改善和幫助完成最終的 PR。 | ||
|
|
@@ -17,11 +17,11 @@ | |
| ## 你需要任何幫助嗎？ | ||
|
|
||
| 若你有任何不知道怎麼處理的事情並未涵蓋進本文章，歡迎[來信](mailto:{{ site.social-network-links.email }})。或者你也可以直接[開一個 issue]({{ site.github.repository_url }}/issues/new) 來詢問，也許大家也有和你一樣的問題，我們一起來解決吧 😬。 | ||
| 若你有任何不知道怎麼處理的事情並未涵蓋進本文章，歡迎[來信](mailto:[email protected])。或者你也可以直接[開一個 issue](https://github.com/evan361425/flutter-pos-system//issues/new) 來詢問，也許大家也有和你一樣的問題，我們一起來解決吧 😬。 | ||
|
|
||
| ## 改善文件 | ||
|
|
||
| 也許你在閱讀文件時，覺得語意怪怪的，或唸起來卡卡的，這代表這段落可能不是那麼完美。你可以先看看有沒有[類似的 issue]({{ site.github.repository_url }}/labels/document)。如果沒有，請[提交相關的 issue]({{ site.github.repository_url }}/issues/new?assignees=&labels=&template=document.md&title=)。 | ||
| 也許你在閱讀文件時，覺得語意怪怪的，或唸起來卡卡的，這代表這段落可能不是那麼完美。你可以先看看有沒有[類似的 issue](https://github.com/evan361425/flutter-pos-system//labels/document)。如果沒有，請[提交相關的 issue](https://github.com/evan361425/flutter-pos-system//issues/new?assignees=&labels=&template=document.md&title=)。 | ||
|
|
||
| 除此之外，在某些情況你可能也需要改善文件： | ||
|
|
||
|
|
@@ -35,7 +35,7 @@ | |
|
|
||
| ## 如何回報程式害蟲 | ||
|
|
||
| 哇哩咧，被你找到 bug 了！請先看看你找到的害蟲是否[已經被回報了]({{ site.github.repository_url }}/labels/bug)。如果還沒有類似的害蟲，請[提交相關的 issue]({{ site.github.repository_url }}/issues/new?assignees=&labels=&template=bug_report.md&title=)。 | ||
| 哇哩咧，被你找到 bug 了！請先看看你找到的害蟲是否[已經被回報了](https://github.com/evan361425/flutter-pos-system//labels/bug)。如果還沒有類似的害蟲，請[提交相關的 issue](https://github.com/evan361425/flutter-pos-system//issues/new?assignees=&labels=&template=bug_report.md&title=)。 | ||
|
|
||
| 這裡有幾個小技巧幫助你撰寫出一個好的害蟲通報文件： | ||
|
|
||
|
|
@@ -54,11 +54,11 @@ | |
|
|
||
| 我們非常歡迎提出新功能，但是思考一下是否該功能和 POS 系統是有關係的，你可以提出想法大家一起來討論看看本功能實作的價值。請提出足夠的細節和可行性，並且說明一下該功能試圖解決的問題。 | ||
|
|
||
| 再次感謝你提出想法幫助本產品更好，開始[建立相關的 issue]({{ site.github.repository_url }}/issues/new?assignees=&labels=&template=feature_request.md&title=) 吧！ | ||
| 再次感謝你提出想法幫助本產品更好，開始[建立相關的 issue](https://github.com/evan361425/flutter-pos-system//issues/new?assignees=&labels=&template=feature_request.md&title=) 吧！ | ||
|
|
||
| ## 調整使用者介面 | ||
|
|
||
| 一個好的應用程式必須要有好的使用者介面，這包括應外觀設計和使用者操作順暢度。若你認為某區塊的顏色應該配上新的色彩，那我們就來試試看吧！請發出[相關的 issue]({{ site.github.repository_url }}/issues/new?assignees=&labels=&template=design.md&title=)。 | ||
| 一個好的應用程式必須要有好的使用者介面，這包括應外觀設計和使用者操作順暢度。若你認為某區塊的顏色應該配上新的色彩，那我們就來試試看吧！請發出[相關的 issue](https://github.com/evan361425/flutter-pos-system//issues/new?assignees=&labels=&template=design.md&title=)。 | ||
|
|
||
| 這裡也提供幾點應注意的事項： | ||
|
|
||
|
|
@@ -68,7 +68,7 @@ | |
|
|
||
| ## 第一次嘗試貢獻 | ||
|
|
||
| 我們很開心你願意貢獻本專案。若你不確定如何開始做任何幫忙，建議你可以看看關於[good first issue]({{ site.github.repository_url }}/issues?q=is%3Aissue+label%3A%22good+first+issue%22)，來看看什麼是好的 issue。除此之外[help wanted]({{ site.github.repository_url }}/issues?q=is%3Aissue+label%3A%22help+wanted%22)也是一個對於不知如何幫忙的人下手的好地方。 | ||
| 我們很開心你願意貢獻本專案。若你不確定如何開始做任何幫忙，建議你可以看看關於[good first issue](https://github.com/evan361425/flutter-pos-system//issues?q=is%3Aissue+label%3A%22good+first+issue%22)，來看看什麼是好的 issue。除此之外[help wanted](https://github.com/evan361425/flutter-pos-system//issues?q=is%3Aissue+label%3A%22help+wanted%22)也是一個對於不知如何幫忙的人下手的好地方。 | ||
|
|
||
| - Good first issues - 應該只會包含少數幾行程式碼的修正和一組單元測試。 | ||
| - Help wanted issues - 可能會需要一些能力和經驗，但卻是一個特別需要大家幫忙的地方。 | ||
|
|
@@ -88,7 +88,7 @@ | |
|
|
||
| 以下是執行程式碼改動的順序。 | ||
|
|
||
| - [Fork]({{ site.github.repository_url }}/fork) 並且複製本專案。 | ||
| - [Fork](https://github.com/evan361425/flutter-pos-system//fork) 並且複製本專案。 | ||
| - 安裝必要檔案：`flutter pub get`。 | ||
| - 安裝輔助工具：`flutter run build_runner build`。 | ||
| - 確保你本地端可以正確執行：`flutter test`。 | ||
|
|
||