Contributing

Learn how to contribute to the sasquatch-backpack open source project.

Guides

• Adding more Datasources
  • Set up locally
  • Make A Source Folder
  • Get the Data
  • Write CLI Command Logic
  • Implement commands with Click
  • Test your Command
  • Add Schemas
    • Note 1: Field
    • Note 2: ID
    • Note 3: Meta
  • Add Configs
  • Add Datasources
  • Update CLI
  • Test it!
• Redis Backpack
  • State Storage
• Development guide
  • Scope of contributions
  • Setting up a local development environment
  • Pre-commit hooks
  • Running tests
  • Building documentation
  • Updating the change log
  • Style guide
    • Code
    • Documentation
• Release procedure
  • Regular releases
    • 1. Change log and documentation
    • 2. GitHub release and tag
  • Backport releases
    • Creating a release branch
    • Developing on a release branch
    • Releasing from a release branch

Reference

• Python API
  • Sasquatch