Contributing

Learn how to contribute to the technote open source project.

Guides

• Development guide
  • Scope of contributions
  • Setting up a local development environment
    • Python set up
    • Node.js set up
  • Pre-commit hooks
  • Running tests
  • Building the demo technote
  • Compiling CSS and JS
  • 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