Skip to content

Commit d2c1da5

Browse files
mikechu-optimizelyandrewleap-optimizely
mikechu-optimizely
and
andrewleap-optimizely
authored
[FSSDK-9555] GitHub Issue Templates (#337)
* Add devcontainer config * Add Ruby flavor GH Issue templates * Add gitlens to devcontainer * Add PR #298 doc fix * Add GitLense to devcontainer * Testing updates to ruby CI * Fix linting item * Rollback CI changes * Add suggested setup from @andrewleap-optimizely * fix for solargraph extension --------- Co-authored-by: Andy Leap <104936100+andrewleap-optimizely@users.noreply.github.com>
1 parent 267d9dd commit d2c1da5

File tree

7 files changed

+168
-3
lines changed

7 files changed

+168
-3
lines changed

‎.devcontainer/devcontainer.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "Ruby SDK",
3+
4+
"image": "mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye",
5+
6+
"postCreateCommand": "set -e && bundle install && gem install optimizely-sdk && rake build && gem install pkg/* && gem install solargraph",
7+
8+
"customizations": {
9+
"vscode": {
10+
"extensions": [
11+
"eamodio.gitlens",
12+
"github.vscode-github-actions",
13+
"castwide.solargraph"
14+
]
15+
}
16+
}
17+
}

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: 🐞 Bug
2+
description: File a bug/issue
3+
title: "[BUG] <title>"
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: SDK Version
16+
description: Version of the SDK in use?
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Current Behavior
22+
description: A concise description of what you're experiencing.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Expected Behavior
28+
description: A concise description of what you expected to happen.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Steps To Reproduce
34+
description: Steps to reproduce the behavior.
35+
placeholder: |
36+
1. In this environment...
37+
1. With this config...
38+
1. Run '...'
39+
1. See error...
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Ruby Version
45+
description: What version of Ruby are you using?
46+
validations:
47+
required: false
48+
- type: textarea
49+
attributes:
50+
label: Rails
51+
description: If you're using Rail, what version?
52+
validations:
53+
required: false
54+
- type: textarea
55+
attributes:
56+
label: Link
57+
description: Link to code demonstrating the problem.
58+
validations:
59+
required: false
60+
- type: textarea
61+
attributes:
62+
label: Logs
63+
description: Logs/stack traces related to the problem (⚠️do not include sensitive information).
64+
validations:
65+
required: false
66+
- type: dropdown
67+
attributes:
68+
label: Severity
69+
description: What is the severity of the problem?
70+
multiple: true
71+
options:
72+
- Blocking development
73+
- Affecting users
74+
- Minor issue
75+
validations:
76+
required: false
77+
- type: textarea
78+
attributes:
79+
label: Workaround/Solution
80+
description: Do you have any workaround or solution in mind for the problem?
81+
validations:
82+
required: false
83+
- type: textarea
84+
attributes:
85+
label: Recent Change
86+
description: Has this issue started happening after an update or experiment change?
87+
validations:
88+
required: false
89+
- type: textarea
90+
attributes:
91+
label: Conflicts
92+
description: Are there other libraries/dependencies potentially in conflict?
93+
validations:
94+
required: false

‎.github/ISSUE_TEMPLATE/ENHANCEMENT.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: ✨Enhancement
2+
description: Create a new ticket for a Enhancement/Tech-initiative for the benefit of the SDK which would be considered for a minor version update.
3+
title: "[ENHANCEMENT] <title>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: Briefly describe the enhancement in a few sentences.
11+
placeholder: Short description...
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: benefits
16+
attributes:
17+
label: Benefits
18+
description: How would the enhancement benefit to your product or usage?
19+
placeholder: Benefits...
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: detail
24+
attributes:
25+
label: Detail
26+
description: How would you like the enhancement to work? Please provide as much detail as possible
27+
placeholder: Detailed description...
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: examples
32+
attributes:
33+
label: Examples
34+
description: Are there any examples of this enhancement in other products/services? If so, please provide links or references.
35+
placeholder: Links/References...
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: risks
40+
attributes:
41+
label: Risks/Downsides
42+
description: Do you think this enhancement could have any potential downsides or risks?
43+
placeholder: Risks/Downsides...
44+
validations:
45+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!--
2+
Thanks for filing in issue! Are you requesting a new feature? If so, please share your feedback with us on the following link.
3+
-->
4+
## Feedback requesting a new feature can be shared [here.](https://feedback.optimizely.com/)

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💡Feature Requests
4+
url: https://feedback.optimizely.com/
5+
about: Feedback requesting a new feature can be shared here.

‎lib/optimizely/bucketer.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ def find_bucket(bucketing_id, user_id, parent_id, traffic_allocations)
110110
# parent_id - String entity ID to use for bucketing ID
111111
# traffic_allocations - Array of traffic allocations
112112
#
113-
# Returns and array of two values where first value is the entity ID corresponding to the provided bucket value
114-
# or nil if no match is found. The second value contains the array of reasons stating how the deicision was taken
113+
# Returns an array of two values where first value is the entity ID corresponding to the provided bucket value
114+
# or nil if no match is found. The second value contains the array of reasons stating how the decision was taken
115115
decide_reasons = []
116116
bucketing_key = format(BUCKETING_ID_TEMPLATE, bucketing_id: bucketing_id, entity_id: parent_id)
117117
bucket_value = generate_bucket_value(bucketing_key)

‎spec/audience_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747

4848
user_meets_audience_conditions, reasons = Optimizely::Audience.user_meets_audience_conditions?(config, experiment, user_context, spy_logger)
4949
expect(user_meets_audience_conditions).to be true
50-
expect(reasons).to eq(["Audiences for experiment 'test_experiment' collectively evaluated to TRUE."])
50+
expect(reasons).to eq(["Audiences for experiment 'test_experiment' collectively evaluated to TRUE."])
5151

5252
# Audience Ids is Empty and Audience Conditions is nil
5353
experiment = config.experiment_key_map['test_experiment']

0 commit comments

Comments
 (0)