NYPL / engineering-general

Standards, values, and other information relevant to the NYPL Engineering Team.

NYPL Engineering

This repo is intended to be used for information relevant to the NYPL Engineering Team.

The key words MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY/OPTIONAL, in these documents are to be interpreted as described in RFC 2119.

Contents

Core Values

• Engineering Values
• Library Values

Policies

• Accessibility
• Privacy & Data Retention

Code Standards

• Coding Style
  • Versioning
  • Naming Conventions
  • Logging
  • Test Coverage
  • Documentation
  • Javascript
    • NYPL React Design System
  • Python
  • Ruby on Rails
  • PHP
• Technical Approach Documents
• Peer Review
• CI Coverage
  • Github Actions
  • Travis CI
• Deployment
  • AWS
  • Node Lambda
• Production Readiness
• Monitoring & Alarms
• Root Cause Analysis

Security

• General
• OAuth
• Secrets Management

Onboarding/Offboarding

• Onboarding
• Offboarding
• GitHub Org Management

How To

• Use AWS