meliorence/react-native-snap-carousel

Setup automated tests and linters on CI

Open

#440 opened on Dec 11, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (10,045 stars) (2,223 forks)batch import
enhancementhelp wanted

Description

Is this a bug report, a feature request, or a question?

Choring! 🧹

I like the project and would like to last long and prosper. That's why I propose to setup a CI (e.g. CircleCI or Travis) that would run following jobs:

  • unit/integration tests with Jest – for components and utility functions (feel free to use react-native-testing-library to ease component testing)
  • e2e tests with Detox – these are nice because they allow testing on actual device with fake gestures
  • ESLint or TSLint - eslint/recommended, eslint-config-react-app and eslint-config-prettier are a good start I think, or we can go with tslint
  • type checking – add Flow or TypeScript to the project (Flow is easier to set, but TS gets wider adoption and has lots of 3rd party typings, so you decide)

Unfortunately I likely won't find time to set any of this up, but I wanted to start this initiative anyway, because somebody surely will get some of this done :)

@bd-arc I think the best first step would be for you to set up circle and base on this configuration from react-native-paper, I copy it all the time for new projects :P

Contributor guide

Tech stack
javascripttypescriptreactjest
Domain
ci cdtestingtooling
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of React NativeFamiliarity with CI (e.g., CircleCI)Understanding of Jest and ESLintKnowledge of Detox for e2e testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the referenced CI configuration from react native paper (https://github.com/callstack/react native paper/blob/master/.circleci/config.yml). Check the comments in this issue for any additional guidance. Set up CircleCI or Travis with jobs for Jest unit/integration tests, Detox e2e tests, ESLint linting, and TypeScript type checking. Follow the recommendations in the issue body for specific packages.