From c52065e6fdad7af5bad5de4ced37c14fcd8eff65 Mon Sep 17 00:00:00 2001 From: Atanda1 Date: Thu, 9 Jan 2025 13:40:01 +0100 Subject: [PATCH 1/2] feat: Add OSS templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 34 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 33 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 5 +++ .github/PULL_REQUEST_TEMPLATE.md | 37 +++++++++++++++++++++++ 4 files changed, 109 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/config.yaml 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 0000000..f7cf6a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**User Story** +> Add the details of this issue from the user's POV + +**Acceptance Criteria(s)** +> 1. **GIVEN** Given that something happens +> **WHEN** Under certain conditions +> **THEN** Then we expect a particular result + +**Tech Details** +>Technical changes that will happen include UI changes, styling updates, integration requirements +* **UI State Changes:** + > Changes to the frontend interface +* **Styling Updates:** + > CSS changes for the application +* **Integration Requirements:** + > Changes to the logic parts of the application or protocol + + +**Design Link** +>* Link to the figma design file + +**Notes/Assumptions** +>* Notes or assumption that has to remain constant. + +**Open Questions** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 0000000..e436354 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request +about: New feature for this project +title: '' +labels: '' +assignees: '' +--- + +**User Story** +> Add the details of this issue from the user's POV + +**Acceptance Criteria(s)** +> 1. **GIVEN** Given that something happens +> **WHEN** Under certain conditions +> **THEN** Then we expect a particular result + +**Tech Details** +>Technical changes that will happen include UI changes, styling updates, integration requirements +* **UI State Changes:** + > Changes to the frontend interface +* **Styling Updates:** + > CSS changes for the application +* **Integration Requirements:** + > Changes to the logic parts of the application or protocol + + +**Design Link** +>* Link to the figma design file + +**Notes/Assumptions** +>* Notes or assumption that has to remain constant. + +**Open Questions** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..abfda5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: "General Support" + url: "https://paycrest.io/" + about: "For general inquiries, visit our support page." diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9dd64ef --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +By submitting a PR to this repository, you agree to the terms within the [Paycrest Code of Conduct](https://www.notion.so/paycrest/Contributor-Code-of-Conduct-1602482d45a2806bab75fd314b381f4c?pvs=4). Please see the [contributing guidelines](https://paycrest.notion.site/Contribution-Guide-1602482d45a2809a8930e6ad565c906a?pvs=4) for how to create and submit a high-quality PR for this repo. + +### Description + +> Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context. +> +> Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, contracts etc. +> +> If the UI is being changed, please provide screenshots. + + +### References + +> Include any links supporting this change such as a: +> +> - GitHub Issue/PR number addressed or fixed +> - StackOverflow post +> - Support forum thread +> - Related pull requests/issues from other repos +> +> If there are no references, simply delete this section. + +### Testing + +> Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this project has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors. +> +> Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests. +> +> Also include details of the environment this PR was developed in (language/platform/browser version). + +- [ ] This change adds test coverage for new/changed/fixed functionality + +### Checklist + +- [ ] I have added documentation for new/changed functionality in this PR +- [ ] All active GitHub checks for tests, formatting, and security are passing +- [ ] The correct base branch is being used, if not `master` \ No newline at end of file From e3ed8fdbb320b222f44e2012d8c19b08fc27e3b8 Mon Sep 17 00:00:00 2001 From: Atanda1 Date: Thu, 9 Jan 2025 15:32:33 +0100 Subject: [PATCH 2/2] feat: Add OSS templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 47 +++++++++++------------ .github/ISSUE_TEMPLATE/Feature_request.md | 3 +- .github/ISSUE_TEMPLATE/config.yaml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 4 files changed, 26 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index f7cf6a5..138ea3b 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,34 +1,31 @@ --- name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +about: Report a bug to help us improve +title: "[BUG] " +labels: bug +assignees: "" --- -**User Story** -> Add the details of this issue from the user's POV - -**Acceptance Criteria(s)** -> 1. **GIVEN** Given that something happens -> **WHEN** Under certain conditions -> **THEN** Then we expect a particular result +**Describe the bug** +A clear and concise description of what the bug is. -**Tech Details** ->Technical changes that will happen include UI changes, styling updates, integration requirements -* **UI State Changes:** - > Changes to the frontend interface -* **Styling Updates:** - > CSS changes for the application -* **Integration Requirements:** - > Changes to the logic parts of the application or protocol +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error +**Expected behavior** +A clear and concise description of what you expected to happen. -**Design Link** ->* Link to the figma design file +**Screenshots** +If applicable, add screenshots to help explain your problem. -**Notes/Assumptions** ->* Notes or assumption that has to remain constant. +**Environment:** +- OS: [e.g., Windows 10, macOS Ventura] +- Browser: [e.g., Chrome 112] +- Version: [e.g., 22.5] -**Open Questions** \ No newline at end of file +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index e436354..b57afcb 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -6,10 +6,11 @@ labels: '' assignees: '' --- + **User Story** > Add the details of this issue from the user's POV -**Acceptance Criteria(s)** +**Acceptance Criteria** > 1. **GIVEN** Given that something happens > **WHEN** Under certain conditions > **THEN** Then we expect a particular result diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index abfda5b..a73ab36 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: "General Support" - url: "https://paycrest.io/" + url: "mailto:devs@paycrest.io" about: "For general inquiries, visit our support page." diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9dd64ef..e0b587b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -By submitting a PR to this repository, you agree to the terms within the [Paycrest Code of Conduct](https://www.notion.so/paycrest/Contributor-Code-of-Conduct-1602482d45a2806bab75fd314b381f4c?pvs=4). Please see the [contributing guidelines](https://paycrest.notion.site/Contribution-Guide-1602482d45a2809a8930e6ad565c906a?pvs=4) for how to create and submit a high-quality PR for this repo. +By submitting a PR to this repository, you agree to the terms within the [Paycrest Code of Conduct](https://paycrest.notion.site/Contributor-Code-of-Conduct-1602482d45a2806bab75fd314b381f4c). Please see the [contributing guidelines](https://paycrest.notion.site/Contribution-Guide-1602482d45a2809a8930e6ad565c906a?pvs=4) for how to create and submit a high-quality PR for this repo. ### Description