From dc80ae5795ed701ebbbffeaeddadafcb46dae850 Mon Sep 17 00:00:00 2001 From: Jeevan Shah Date: Mon, 27 Sep 2021 09:01:45 -0400 Subject: [PATCH] chore: Dev pr template (#495) * chore: add pr templates * Move title formatting and make speed optional --- .github/CONTRIBUTING.md | 4 ++++ .github/PULL_REQUEST_TEMPLATE/feature.md | 14 ++++++++++++++ .github/PULL_REQUEST_TEMPLATE/plugin.md | 16 ++++++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/plugin.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8ba70be..a70fc6a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -37,6 +37,10 @@ If you wish to contribute to NvChad, you should: - When making a PR (pull request), please be very descriptive about what you've done! +- PR titles should be formatted with 'fix', 'chore' or 'feat'. ex: `feat: add new plugin` + +- PRs should follow the pull request formats where applicable + - We are open to all PRs, but may decline some for a myriad of reasons. Though don't be discouraged! We'll still be open to discussions. - PR's are always welcomed however NvChad aims to be less bloated. So PR's regarding existing plugin's enhancement and creating new features with existing plugins itself ( without adding a new plugin), bug fixes and corrections are more encouraged. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 0000000..a622846 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,14 @@ + +Fixes Issue # (If it doesn't fix an issue then delete this line) + +Features Added: +- Plugin Name (Add links if possible too) + +Reasoning: +List why the feature is needed + +Speed (If applicable): +Show the impact on the speed of nvChad + +Other: +Anything else relevant goes here diff --git a/.github/PULL_REQUEST_TEMPLATE/plugin.md b/.github/PULL_REQUEST_TEMPLATE/plugin.md new file mode 100644 index 0000000..28ae8d3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/plugin.md @@ -0,0 +1,16 @@ +(Make sure your title is either: 'fix', 'chore', or 'feat' then your title. ex: `fix: add new plugin`) + +Fixes Issue # (If it doesn't fix an issue then delete this line) + +Plugins Added: +- [Plugin Name](Plugin Link) +- [Plugin Name](Plugin Link) + +Reasoning: +List why the plugin(s) should be added + +Speed: +Show the impact on the speed of nvChad + +Other: +Anything else relevant goes here