Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (33 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

38 lines (33 loc) · 1.68 KB

Development of streamlit-webrtc

Set up

  • Install uv
  • Install dependencies 
    $ uv sync
  • Install pre-commit 
    $ pre-commit install

Development

  • Edit streamlit_webrtc/component.py to set _RELEASE = False in order to show the frontend view served from a development server as below instead of the production build.
    • Do not commit this change. This setting is only for development.
    • If _RELEASE = False is set, the build command fails, which is described in the next section. See the build rule in Makefile and release_check.py for the details.
  • Run the frontend dev server 
    $ cd streamlit_webrtc/frontend
$ pnpm dev
  • In another shell, run app.py 
    $ streamlit run home.py

Changelog management and release

  1. All contributors: Run scriv create (scriv create --edit to open an editor) to create a changelog fragment (changelog.d/*.md), fill it to describe the changes you made, and commit it. You should add a fragment for each pull request describing the changes made in the PR.
  2. Maintainers: CI creates a PR to review the changelog collected from the committed fragments when a commit including changelog fragments is pushed to main. When to release, after reviewing the changelog preview PR, merge it to main. This triggers another CI/CD process that creates a new release with an updated changelog based on the merged changelog preview PR.

Build

The following command is run to build the package during the automated release process in CI/CD described above. When you want to run the build locally for development or test, you can directly use this command.

$ make build