From 65ad6e66bca9e7827ca9185ed1cfa207b6dd78fa Mon Sep 17 00:00:00 2001 From: jmeridth Date: Wed, 14 Feb 2024 08:35:27 -0600 Subject: [PATCH 1/2] chore: add github issue templates You can find examples [here](https://github.com/procore-oss/oss-template/issues/new/choose) [Bug Issue](https://github.com/procore-oss/oss-template/issues/new?assignees=&labels=bug%2Cneeds-triage&projects=&template=bug.yml&title=%5Bbug%5D+%3Ctitle%3E) [Documentation Issue](https://github.com/procore-oss/oss-template/issues/new?assignees=&labels=docs%2Cneeds-triage&projects=&template=docs.yml&title=%5Bbug%5D+%3Ctitle%3E) [Feature Issue](https://github.com/procore-oss/oss-template/issues/new?assignees=&labels=feature%2Cneeds-triage&projects=&template=feature-request.yml&title=%5BFeature+Request%5D+%3Ctitle%3E) [Question Issue](https://github.com/procore-oss/oss-template/issues/new?assignees=&labels=question%2Csupport%2Cneeds-triage&projects=&template=question-support.yml&title=%5BQuestion%2FSupport%5D+%3Ctitle%3E) - [x] remove broken link in CODE_OF_CONDUCT.md - [x] change gemspec email to opensource@procore.com Signed-off-by: jmeridth --- .github/ISSUE_TEMPLATE/bug.yml | 66 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/docs.yml | 18 ++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 36 +++++++++++ .github/ISSUE_TEMPLATE/question-support.yml | 18 ++++++ CODE_OF_CONDUCT.md | 2 +- blueprinter.gemspec | 2 +- 7 files changed, 141 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question-support.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..bd3c1c9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,66 @@ +name: 🐞 Bug +description: File a bug/issue +title: "[bug] " +labels: [bug, needs-triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: checkboxes + attributes: + label: Is this a regression? + description: Did this behavior work before? + options: + - label: Yes, this used to work before + required: false +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. + 2. + 3. + 4. + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: OSX 13.3.1 + - **Browser Name and Version**: Chrome Version 112.0.5615.49 (Official Build) (arm64) + - **Ruby Version**: 3.0.0 + value: | + - OS: + - Browser Name and version: + - Ruby Version: + render: markdown + validations: + required: true +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3ba13e0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 00000000..387c39d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,18 @@ +name: 📚 Documentation or README.md issue report +description: File a bug/issue for docs or README.md +title: "[bug] <title>" +labels: [docs, needs-triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Docs/README.md Part to update + description: A concise description of what you thing should be updated + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..023dc72c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: 🚀🆕 Feature Request +description: Suggest an idea or possible new feature for this project +title: "[Feature Request] <title>" +labels: [feature, needs-triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd lik + description: A clear and concise description of what you want to happen + validations: + required: true +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + validations: + required: false +- type: textarea + attributes: + label: Additional context + description: Add any other context or additional information about the problem here + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question-support.yml b/.github/ISSUE_TEMPLATE/question-support.yml new file mode 100644 index 00000000..c37ec1d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-support.yml @@ -0,0 +1,18 @@ +name: ❓ Question or Support Request +description: Questions and requests for support +title: "[Question/Support] <title>" +labels: [question, support, needs-triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Describe your question or ask for support + description: A concise description of what you would like support with + validations: + required: true diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f56f7f72..c7862979 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -63,7 +63,7 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <opensource@procore.com>. All complaints will be reviewed and investigated promptly and fairly by -the [Procore Open Source Program Office (OSPO)](docs/contact.md) +the Procore Open Source Program Office (OSPO) All community leaders are obligated to respect the privacy and security of the reporter of any incident. diff --git a/blueprinter.gemspec b/blueprinter.gemspec index 52f0d15b..c4eee418 100644 --- a/blueprinter.gemspec +++ b/blueprinter.gemspec @@ -10,7 +10,7 @@ Gem::Specification.new do |s| s.name = 'blueprinter' s.version = Blueprinter::VERSION s.authors = ['Procore Technologies, Inc.'] - s.email = ['blueprinter@googlegroups.com'] + s.email = ['opensource@procore.com'] s.homepage = 'https://github.com/procore-oss/blueprinter' s.summary = 'Simple Fast Declarative Serialization Library' s.description = 'Blueprinter is a JSON Object Presenter for Ruby that takes business objects ' \ From 3d4e29f4ad29910cb2f11608dc9a847c628c2147 Mon Sep 17 00:00:00 2001 From: Jason Meridth <jmeridth@gmail.com> Date: Fri, 16 Feb 2024 09:36:55 -0600 Subject: [PATCH 2/2] Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: Jake Sheehy <jacobjsheehy@gmail.com> Signed-off-by: Jason Meridth <jmeridth@gmail.com> --- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 023dc72c..e51081f5 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -18,7 +18,7 @@ body: required: true - type: textarea attributes: - label: Describe the solution you'd lik + label: Describe the feature you'd like to see implemented description: A clear and concise description of what you want to happen validations: required: true