Skip to content

Commit a6e1261

Browse files
authored
FDT-20 - Updating read-me with maintenance instructions (#261)
1 parent 025d902 commit a6e1261

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Classify Client
22

3-
This is an optimized version of the classify client endpoint in [Normandy](https://github.com/mozilla/normandy).
3+
This is an optimized version of the classify client endpoint, originally forked from [Normandy](https://github.com/mozilla/normandy).
4+
5+
This service returns basic information to gecko clients like country code and a timestamp for feature toggling/targetting.
46

57
## Dev instructions
68

@@ -13,10 +15,19 @@ $ cargo run
1315

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

18+
## Maintenance instructions
19+
20+
- Dependabot is setup to run monthly
21+
- Major and minor updates will be split into seperate PRs.
22+
- Since this is a rust project, breaking changes will occur in patch version changes at times.
23+
- Changes will deploy to staging automatically for verification when after merging.
24+
- Use a VPN to spot check response accuracy from different locations.
25+
- Tagged releases will deploy to prod automatically when releases are created.
26+
1627
### GeoIP Database
1728

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

2132
## Configuration
2233

0 commit comments

Comments
 (0)