TomographicImaging / CIL

A versatile python framework for tomographic imaging
https://tomographicimaging.github.io/CIL/
Apache License 2.0
98 stars 45 forks source link

Contributor guide #1233

Open nabriis opened 2 years ago

nabriis commented 2 years ago

I noticed that there is no contributor guide in the docs. A contributor guide is very useful for first-time contributors. It is also useful for providing any (novice or experienced) contributors with specifics related to this project, like how to run tests!

Since I just went through the process I could take a stab at it. Might need a bit of guidance for how to build/run tests.

I really like the short summary in the NumPy contributor guide.

Some suggested points to focus on:

paskino commented 2 years ago

Some ideas

https://the-turing-way.netlify.app/welcome

https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md