Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Contributing

Thanks for taking the time to contribute.

Ground rules

  1. Never commit real identifiers. No tenant IDs, workspace IDs, client IDs, subscription names, connection strings or customer names. Use the *.example files and keep the real ones git-ignored.
  2. Never commit customer names or branding. These are reference implementations. Use fictional organisations.
  3. Keep demo data synthetic and reproducible. Data is generated by scripts with a fixed seed. Change the generator, then regenerate — do not hand-edit CSVs.
  4. Do not commit generated binaries. Decks and exports are rebuilt from source (node presentation/build_deck.js).

Getting started

git clone https://github.com/Statyx/<repo>.git
cd <repo>
pip install -r requirements.txt
cp src/config.example.yaml src/config.yaml   # then fill in your own IDs

Before opening a pull request

pytest tests/ -q

Repositories with a CI workflow also run an anti-leak scan that fails the build if a customer name or a hardcoded GUID is detected. Run it locally if you are unsure.

Commit messages

Conventional commits are used where practical: feat:, fix:, docs:, chore:, refactor:, test:.

Reporting problems

  • Bugs and ideas — open an issue.
  • Security issues or exposed credentials — see SECURITY.md, and do not open a public issue.

About

Default community health files for all Statyx repositories

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors