From 853c24e06bb3db10b562b439ec64dc934d3a0aed Mon Sep 17 00:00:00 2001 From: crnh <30109443+crnh@users.noreply.github.com> Date: Mon, 26 Aug 2024 09:24:29 +0200 Subject: [PATCH] Add basic contribution guidelines --- CONTRIBUTING.md | 8 ++++++++ README.md | 4 ++++ 2 files changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..61e5a08 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## Contributing + +Visisipy aims to be a community-driven project and warmly accepts contributions. If you want to contribute, please email us (visisipy@mreye.nl) or [open a new discussion](https://github.com/MREYE-LUMC/visisipy/discussions). + +## Code style + +- Please format your docstrings according to [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html). +- Use `hatch` to lint, format and test the code. diff --git a/README.md b/README.md index f7cbe04..02a5c75 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ This project aims to provide a standardized method to perform optical (ray traci 3. Decouple the model definition interface as much as possible from the simulation software, i.e. Zemax OpticStudio; 4. Introduce this as a standardized method for optical simulations of the eye, that can be used by the broader physiological optics community. +## Contributing + +Visisipy aims to be a community-driven project and warmly accepts contributions. If you want to contribute, please email us (visisipy@mreye.nl) or [open a new discussion](https://github.com/MREYE-LUMC/visisipy/discussions). + ## Current implementation In its current state, `EyeSimulator` provides