desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.
https://cheetah-accelerator.readthedocs.io
GNU General Public License v3.0
30 stars 13 forks source link

Create contribution guide #6

Closed jank324 closed 1 year ago

jank324 commented 1 year ago

📚 Documentation

Create a guide on how to contribute to this project, for example in the README or somewhere separate (check how it's done in other projects and select what we like).

The guide should include what our process is, maybe a reference to testing once we have that as well as guidelines on code style such as using isort and black.

Motivation

Making contributions easy might encourage them. A well formulated process and code style will improve code quality.