Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

Contributing to PANDA

General workflow

To contribute code:

  1. Create a new branch from main using an explicit name (e.g. add-cavity-simulation, simplify-camera-interface, light-matter-simulation,...)
  2. Make your changes.
  3. Test your changes locally.
  4. Open a Pull Request describing what was changed and why.
  5. Merge only after review.

The main branch should always contain working code.

Pull Requests

A Pull Request should explain:

  • What changed?
  • Why was it changed?
  • How was it tested?

For physics-related changes, include relevant:

  • plots
  • comparison with previous results
  • simulation parameters
  • experimental conditions

Keep Pull Requests focused: one PR should ideally address one main topic.

Releases

Packages

Contributors