splitrb / split-api Goto Github PK
View Code? Open in Web Editor NEW:signal_strength: JSON API to the split ab testing library
License: MIT License
:signal_strength: JSON API to the split ab testing library
License: MIT License
๐ Hey there! This is the developer experience audit from @mntnr for this repository. I've added in my thoughts below, in the form of a checklist. Looking forward to seeing what you think; let's see if we can resolve all of the open issues and make this repository shine โจ ๐ โจ
๐ถ JSON API to the split A/B testing library
For notes on anything crossed out, look below. Note: I use [~]
to mean that I have proposed a fix in a PR. I know it doesn't render properly in Markdown, but it works pretty well otherwise for that purpose. If I think that something is fine, even if it isn't valid according to this checklist, I've checked it off and included a note.
LICENSE
file?
.gemspec
?.github
or docs
folder? See TODO section below for recommendation.
ISSUE_TEMPLATE.md
?PULL_REQUEST_TEMPLATE.md
?CONTRIBUTING.md
file? See TODO section below for recommendation.
good first issue
label as a starting point?CHANGELOG
?
alex
adequately? Run alex *.md
. 5 warnings, all false positives.help wanted
.good for beginners
or good first issue
label?waiting on contributor
label?Note: Neither of these are necessary, but they can help with some things. Check out https://probot.github.io/ for some tools.
Note: These should apply to the .gemspec
file here.
bugs
field?homepage
field?keywords
?
depcheck
; do the deps make sense?CONTRIBUTE.md
similar to the main split repo's (see list above for recommended elements to include).split-api.gemspec
file.split
repo points to your Google Groups; this works unless you have a different collaboration medium you prefer (but recommend adding to Contribute section of readme and/or CONTRIBUTE.md).ISSUE_TEMPLATE.md
and PULL_REQUEST_TEMPLATE.md
files to your repository. These may help you in the future.available
labels as well as good first issue
. These can be used to signal that you're looking for community involvement for issues. They can also be configured to display on http://up-for-grabs.net. This will help more people interact with your code, and lead to small, iterative work done by others. It may take some time to set up initially - properly scoping issues for newcomers takes some time - but the payback should be worth it.waiting on contributor
. This helps alleviate pressure on you to close them.This checklist is open source! If you have suggestions or think it could be better, contribute back on mntnr/audit-templates.
As well - note that you don't need to tick every box. If you have anything you'd like to talk about, I'm here; otherwise, I would suggest either pulling out tasks into a comment before, or into other issues, and then closing the issue when you feel you've adequately done everything. If you want help here, let me know.
Thank you!
Dependabot can't evaluate your Ruby dependency files.
As a result, Dependabot couldn't check whether any of your dependencies are out-of-date.
The error Dependabot encountered was:
Bundler::Dsl::DSLError with message:
[!] There was an error parsing `Gemfile`:
[!] There was an error while loading `split-api.gemspec`: undefined method `bug_tracker_uri=' for #<Gem::Specification:0x000055bfeaf95d30>. Bundler cannot continue.
# from /home/dependabot/dependabot-updater/dependabot_tmp_dir/split-api.gemspec:9
# -------------------------------------------
# "sanitized"
> gem.bug_tracker_uri = 'http://github.com/splitrb/split-api/issues'
# "sanitized"
# -------------------------------------------
. Bundler cannot continue.
# from /home/dependabot/dependabot-updater/dependabot_tmp_dir/Gemfile:4
# -------------------------------------------
# # Specify your gem's dependencies in split-api.gemspec
> gemspec
# -------------------------------------------
You can mention @dependabot in the comments below to contact the Dependabot team.
Dependabot can't evaluate your Ruby dependency files.
As a result, Dependabot couldn't check whether any of your dependencies are out-of-date.
The error Dependabot encountered was:
Bundler::Dsl::DSLError with message:
[!] There was an error parsing `Gemfile`:
[!] There was an error while loading `split-api.gemspec`: undefined method `bug_tracker_uri=' for #<Gem::Specification:0x00005653a8c9a160>. Bundler cannot continue.
# from /home/dependabot/dependabot-updater/dependabot_tmp_dir/split-api.gemspec:9
# -------------------------------------------
# "sanitized"
> gem.bug_tracker_uri = 'http://github.com/splitrb/split-api/issues'
# "sanitized"
# -------------------------------------------
. Bundler cannot continue.
# from /home/dependabot/dependabot-updater/dependabot_tmp_dir/Gemfile:4
# -------------------------------------------
# # Specify your gem's dependencies in split-api.gemspec
> gemspec
# -------------------------------------------
You can mention @dependabot in the comments below to contact the Dependabot team.
I am wondering about the status of this repository with respect to functionality.
Looking at the code, the /finished
endpoint is calling a method (finished
) that doesn't exist in Split::Helper module.
Changing finished
to ab_finished
seems to work.
I would like to use this gem to run experiments for users of an Ember app. The XHR request to get an alternative for an experiment (/ab_test
) is working as expected, but the POST /finished
request doesn't actually complete an experiment for a particular user. I'm guessing this is because split can't find a user at that point. It looks like I need to create a persistence adapter. I was thinking I would change GET /ab_test
to return a uuid along with the alternative, Ember would store the uuid and pass that into the POST /finished
.
Thoughts?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.