steveklabnik/rustdoc

Write more tests

Open

#75 opened on Jul 27, 2017

View on GitHub
 (6 comments) (0 reactions) (0 assignees) (22 forks)github user discovery
E-Easybackendenhancementhelp wanted

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Now that we have a test framework, we should verify everything in the JSON. Right now, we only have two tests: https://github.com/steveklabnik/rustdoc/tree/master/tests/source

testing all aspects of https://github.com/steveklabnik/rustdoc/blob/master/frontend/public/data.json is good; that'd take two steps:

  1. we should use jsonapi to validate that it's proper JSON-API
  2. we should test that the proper relationships are created

Contributor guide

Research direction
Validate the data.json using jsonapi crate and ensure proper relationships are created with Rust test framework.
Tech stack
rust
Domain
testing
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70