816e92e549
* AB Test for Feed Strategy Adding the plumbing for performing AB Tests on the feed strategy. You can add the environment variable `AB_TEST_SERVICE_FEED_STRATEGY` to specify the field test to run. For example, from the forem application home directory you can run the following to force a strategy for all users: ```console AB_TEST_SERVICE_FEED_STRATEGY=original bin/start ``` Forcing the strategy can significantly help with quality assurance testing. * Adding configurable weighted feed strategy I wrote about this exploration on [DEV.to][1]. This particular implementation provides significant configuration options for A/B testing. At it's core this `Articles::Feeds::WeightedQueryStrategy` provides a means to query articles that are relevant to the user. The configuration helps us test and refine those values. Further more this implementation introduces the idea of some common interfaces for feed strategies. I'm not happy with the naming convention but we can work to change that. This even hints at a mechanism for administrators to configure. Related to forem/rfcs#314, as I work towards understanding the feed algorithm. And #15180 [1]:https://dev.to/jeremyf/practicing-postgresql-and-postulating-improvements-5m * Renaming AbTestService to AbExperiment I'm loath to end any production class's filename with "test". I don't want minitest or rspec coming along and attempting to "test" that file. In addition, I find that Experiment better describes the concept. Also, per conversations with Michael K, we favor nouns objects to go in app/models and verb objects to go in app/services. That's a great separation. * Factoring AbExperiment into a Controller concern I wish this could be a stand-alone module but the implementation of field test has cases that require controller context. * Sanitizing configurable weighted strategy cases * Minor refactoring of coding structure * Renaming parameter for clarity * Renaming variable to avoid confusion Prior to the commit, `env` is a controller variable. The injected `env` variable didn't collide, but did create just a bit of confusion. With this change, I'm trying to disentangle from that variable. * Factoring AbExperiment away from mixin concern Per discussion with Michael K, we both agree that we do not like controller concern mixins. They can quickly complicate the legibility of any given codebase. This refactor provides a common and simplified interface for a Plain Old Ruby Object (PORO) that accounts for the implementation considerations of the underlying "field_test" controller method. * Adding Datadog.tracer.trace around feed actions * Adding featured_article_factor Prior to this commit, there was no consideration for how moderators engage with an article. This is a first nudge towards that effort. * Removing spec Add a spec that says yes or no we're feature testing something seems fragile. Namely, why are we wanting to assert that as a truism. * Helping ensure we're "tracing" the same things From the code comment: > Hey, why the to_a you say? Because the > LargeForemExperimental has already done this. But the > weighted strategy has not. I also don't want to alter the > weighted query implementation as it returns a lovely > ActiveRecord::Relation. So this is a concession. * Addressing parameters for tracing function * For weight feed query only count positive tags A user assigns explicit points to the tags that they do or do not want to see. This change treats the negative explicit_points as an indicator that they don't want to see the tag. * Adding weighted factor for privileged user reactions * Updating comments to better clarify * Adding additional constraint for published_at * Updating documentation and adding logger * Adding documentation concerning method call * Upping logging level for experiments See conversations in https://github.com/forem/forem/pull/15240 * Adding group by clauses to appease postgres configs * Injecting relevant scoring method's joins Prior to this commit, we included all of the joins regardless of the scoring methods chosen. With this commit, we only inject joins that are used with the commit. What this would allow us to do is to then have some pre-cooked scoring methods but not turn them on. Or to turn off the more expensive scoring methods. * Adding feature flag for feed strategy experiment |
||
|---|---|---|
| .buildkite | ||
| .gems | ||
| .github | ||
| .husky | ||
| .vscode | ||
| .yarn/releases | ||
| app | ||
| bin | ||
| config | ||
| cypress | ||
| datadog | ||
| db | ||
| lib | ||
| log | ||
| public | ||
| scripts | ||
| spec | ||
| vendor | ||
| .codeclimate.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .env_sample | ||
| .erb-lint.yml | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .gitpod.dockerfile | ||
| .gitpod.yml | ||
| .lintstagedrc.js | ||
| .nvmrc | ||
| .postcssrc.yml | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .rspec | ||
| .rubocop.yml | ||
| .rubocop_todo.yml | ||
| .ruby-version | ||
| .simplecov | ||
| .slugignore | ||
| .travis.yml | ||
| .yardopts | ||
| .yarnclean | ||
| .yarnrc | ||
| babel.config.js | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| config.ru | ||
| container-compose.yml | ||
| Containerfile | ||
| CONTRIBUTING.md | ||
| customJsDomEnvironment.js | ||
| cypress.dev.json | ||
| cypress.json | ||
| docker-compose.yml | ||
| Dockerfile | ||
| empty-module.js | ||
| Gemfile | ||
| Gemfile.lock | ||
| gitpod-init.sh | ||
| Guardfile | ||
| jest.config.js | ||
| jsconfig.json | ||
| LICENSE.md | ||
| package.json | ||
| postcss.config.js | ||
| Procfile | ||
| Procfile.dev | ||
| Procfile.dev-hot | ||
| Rakefile | ||
| README.md | ||
| release-tasks.sh | ||
| SECURITY.md | ||
| svgo.config.js | ||
| testSetup.js | ||
| yarn.lock | ||
Forem 🌱
For Empowering Community
Welcome to the Forem codebase, the platform that powers dev.to. We are so excited to have you. With your help, we can build out Forem’s usability, scalability, and stability to better serve our communities.
What is Forem?
Forem is open source software for building communities. Communities for your peers, customers, fanbases, families, friends, and any other time and space where people need to come together to be part of a collective. See our announcement post for a high-level overview of what Forem is.
dev.to (or just DEV) is hosted by Forem. It is a community of software developers who write articles, take part in discussions, and build their professional profiles. We value supportive and constructive dialogue in the pursuit of great code and career growth for all members. The ecosystem spans from beginner to advanced developers, and all are welcome to find their place within our community. ❤️
Table of Contents
- What is Forem?
- Table of Contents
- Community
- Contributing
- Getting Started
- Developer Documentation
- Core team
- Vulnerability disclosure
- License
Community
For a place to have open discussions on features, voice your ideas, or get help with general questions please visit our community at forem.dev.
Contributing
We encourage you to contribute to Forem! Please check out the Contributing to Forem guide for guidelines about how to proceed.
Getting Started
This section provides a high-level quick start guide. If you're looking for a more thorough installation guide (for example with macOS, you'll want to refer to our complete Developer Documentation.
We run on a Rails backend, and we are currently transitioning to a Preact-first frontend.
A more complete overview of our stack is available in our docs.
Prerequisites
Local
- Ruby: we recommend using rbenv to install the Ruby version listed on the badge.
- Yarn 1.x: please refer to their installation guide.
- PostgreSQL 11 or higher.
- ImageMagick: please refer to ImageMagick's installation instructions.
- Redis 4 or higher.
Containers
Linux
- Podman 1.9.2 or higher
- Podman Compose 0.1.5 or higher
OS X
Installation Documentation
Please see our installation guides, such as the one for macOS.
Developer Documentation
Check out our dedicated docs page for more technical documentation.
Core team
- @benhalpern
- @jessleenyc
- @peterkimfrank
- @maestromac
- @zhao-andy
- @lightalloy
- @atsmith813
- @citizen428
- @nickytonline
- @joshpuetz
- @juliannatetreault
- @ridhwana
- @fdoxyz
- @msarit
- @jdoss
- @cmgorton
- @andygeorge
- @phannon716
- @s_aitchison
- @jgaskins
- @djuber
- @rt4914
- @jeremyf
Vulnerability disclosure
Forem is the open source software which powers DEV.
We welcome security research on DEV under the terms of our vulnerability disclosure policy.
Acknowledgments
Thank you to the Twemoji project for the usage of their emojis.
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Please see the LICENSE file in our repository for the full text.
Like many open source projects, we require that contributors provide us with a Contributor License Agreement (CLA). By submitting code to the Forem project, you are granting us a right to use that code under the terms of the CLA.
Our version of the CLA was adapted from the Microsoft Contributor License Agreement, which they generously made available to the public domain under Creative Commons CC0 1.0 Universal.
Any questions, please refer to our license FAQ doc or email yo@dev.to.
Happy Coding ❤️