Skip to content

FDT-20 - Updating read-me with maintenance instructions #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexcottner merged 2 commits into from
Jul 8, 2026
+13 −2
Merged

FDT-20 - Updating read-me with maintenance instructions #261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f88e5da
FDT-20 - Updating read-me with maintenance instructions
alexcottner Jul 7, 2026
db0e362
Merge branch 'master' into fdt-20
alexcottner Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Classify Client

This is an optimized version of the classify client endpoint in [Normandy](https://github.com/mozilla/normandy).
This is an optimized version of the classify client endpoint, originally forked from [Normandy](https://github.com/mozilla/normandy).

This service returns basic information to gecko clients like country code and a timestamp for feature toggling/targetting.

## Dev instructions

Expand All @@ -13,10 +15,19 @@ $ cargo run

This project should run on the latest stable version of Rust. Unstable features are not allowed.

## Maintenance instructions

- Dependabot is setup to run monthly
- Major and minor updates will be split into seperate PRs.
- Since this is a rust project, breaking changes will occur in patch version changes at times.
- Changes will deploy to staging automatically for verification when after merging.
- Use a VPN to spot check response accuracy from different locations.
- Tagged releases will deploy to prod automatically when releases are created.

### GeoIP Database

A GeoIP database will need to be provided. By default it is expected to be
found at `./GeoLite2-Country.mmdb`.
found at `./GeoLite2-Country.mmdb` by default.

## Configuration

Expand Down
Loading