diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 90a74609bdf3..d94000c66c05 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -16,23 +16,23 @@ assignees: '' - [ ] I'd be willing to implement this feature ([contributing guide](https://yarnpkg.com/advanced/contributing)) - [ ] This feature is important to have in this repository; a contrib plugin wouldn't do -**Describe the user story** +## Describe the user story A clear and concise description of what workflow is meant to be improved. Example: "As a developer, I often want to do , but I often face ". -**Describe the solution you'd like** +## Describe the solution you'd like A clear and concise description of what you want to happen. Consider that Yarn is used by many people, and your particular use case might not make sense to implement in the core. -**Describe the drawbacks of your solution** +## Describe the drawbacks of your solution This section is important not only to identify future issues, but also for us to see whether you thought through your request. When filling it, ask yourself what are the problems we could have maintaining what you propose. How often will it break? -**Describe alternatives you've considered** +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered, and why you think they wouldn't be good enough. Start by: why not make it a plugin? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 93a7dcdc5a4c..23476846e268 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,18 @@ -**What's the problem this PR addresses?** +## What's the problem this PR addresses? + ... -**How did you fix it?** +## How did you fix it? + ... -**Checklist** +## Checklist +