なぜあなたのプル要求を動機付ける必要がありますか?



すべてのプログラマはGitHubまたは別のGitリポジトリを使用します.良い広報の説明は、コミュニケーションの手がかりです.あなただけのPRで同僚のコードを理解するために数時間を過ごすしたくない.別の良い例は、数日または数週間後に問題に戻るとき、この説明は、数分ではなく、あなたの仕事に戻ることができます.
ここではPRの説明のための私の推薦です.
## Description
This PR will resolve nested lists compiled from markdown. Solution description
## Solution description
In the HtmlRender component I imported a new component `List` where I implemented methods and CSS for the nested list, in the past, we did not have any implementation for List. I discussed with our Designer [here it’s the link for this conversation] and we added square dots for the list, and small numbers for the ordered list. In the List component, I created two methods: one for unordered lists named unorderedList and orderedList for ordered lists.
## Jira ticket
https://[team].atlassian.net/jira/software/projects/[project]/boards/selectedIssue=[issue]
## Did you test this issue on all browsers?
[x] Chrome
[x] FireFox
[x] Edge
[x] Safari
[x] Mobile Safari/Chrome
[x] Tablet Safari/Chrome

説明


この場所では、プル要求の著者は、このPRで解決したいいくつかの単語の問題で記述すべきです.それは短いが価値がある必要があります.それはエッセイ、レビュー、別の同僚のための場所ではないか、簡単にここで解決したいことを理解する必要があります.
例えば、
This PR will resolve nested lists compiled from markdown.Solution description

解決説明


これは、あなたの手順を記述する必要があります場所、あなたが追加、変更、または削除されます.解決説明はあなたがあなたのステップを説明するか、あなたの考えを説明するジャーナルのようです.
例:
In the HtmlRender component I imported a new component `List` where I implemented methods and CSS for the nested list. In the past, we did not have any implementation for List. I discussed with our Designer [here it’s the link for this conversation] and we added square dots for the list, and small numbers for the ordered list. In the List component, I created two methods: one for unordered lists named unorderedList and orderedList for ordered lists.

JIRAチケット


ここでは、JIRAを別のサービスに追加しない場合は、チケットへのリンクを追加します.

すべてのブラウザでこの問題をテストしましたか?


これはチェックリストの場所です.Web上でテストしない場合は、別のリストを追加します.
あなたの注意をありがとう!あなたのフィードバックに感謝します.