From 9e3e0dd696f414b5f483d15966e1236867374978 Mon Sep 17 00:00:00 2001 From: Olivia Guyot Date: Thu, 18 Jan 2024 11:37:29 +0100 Subject: [PATCH] Add templates for issues and PR --- .github/ISSUE_TEMPLATE/bug_report.md | 49 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 33 +++++++++++++ .github/ISSUE_TEMPLATE/proposal.md | 57 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 45 ++++++++++++++++++ 4 files changed, 184 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/proposal.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..1dd178b2b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,49 @@ +--- +name: Bug report +about: Create a report to help us improve GeoNetwork-UI +title: '' +labels: 'bug' +assignees: '' +--- + +### Describe the bug + +When opening the application [...] + + + +- GeoNetwork-UI version used: [`X.X.X` or `main`] + +- Application: [...] + + + +### Expected behaviour + +The application should [...] + + + +### Steps To Reproduce + +- Run [...] +- Open [...] +- Click on [...] + + + +### Screenshots + +[...] + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..d5ad669ad0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request +about: Suggest an idea or request a feature for this project +title: '' +labels: 'feature request' +assignees: +--- + +### Description + +I would like to request adding [...] + + + +### Motivation + +This request stems from the fact that [...] + + + +### Inspiration and context + +This request takes inspiration from [...] + + diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md new file mode 100644 index 0000000000..bf1980d60b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -0,0 +1,57 @@ +--- +name: Proposal +about: Describe a feature or tech task that you intend to push forward +title: '' +labels: 'enhancement' +assignees: '' +--- + +### Description of the proposal + +This proposal aims at adding [...] + +The final outcome will be [...] + + + +### Motivation + +This proposal stems from the fact that [...] + + + +### Scope + +This proposal affects [...] + + + +### Possible alternatives + +Another way of achieving this could be to [...] + + + +### Inspiration and context + +This proposal takes inspiration from [...] + + + +--- + + + +**This work is sponsored by [Organization ABC](xx)**. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..4420beff93 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,45 @@ +### Description + +This PR introduces [...] + + + +### Architectural changes + +The following library now depends on [...] + + + +### Screenshots + +[...] + + + +### Quality Assurance Checklist + +- [ ] Commit history is devoid of any _merge commits_ and readable to facilitate reviews +- [ ] If **new logic** ⚙ī¸ is introduced: unit tests were added +- [ ] If **new user stories** 🤏 are introduced: E2E tests were added +- [ ] If **new UI components** 🕹ī¸ are introduced: corresponding stories in Storybook were created +- [ ] If **breaking changes** đŸĒš are introduced: add the `breaking change` label +- [ ] If **bugs** 🐞 are fixed: add the `backport ` label +- [ ] The [documentation website](docs) 📚 has received the love it deserves + + + +--- + + + +**This work is sponsored by [Organization ABC](xx)**.