Skip to content

How to contribute

esgomezm edited this page Nov 28, 2023 · 13 revisions

Guidelines

We welcome the contribution of notebooks following the ZeroCostDL4Mic guidelines. These are as follows:

  • Contributions are hosted in external repositories owned by the contributor(s). The ZeroCostDL4Mic website will provide links to these repositories. The contributor is responsible for providing support for their own networks.
  • Contributed notebooks should follow the structure we provide in this template notebook Open In Colab
  • Links to example microscopy training and test data need to be provided so that users can easily test the featured notebooks.
  • Quality control steps need to be in place to validate both training and inference. Contributors are invited to see examples from our fully supported networks.
  • And of course, the network needs to work with the example data.

Submitting a contribution

When you're ready, please send us an email with the following information:

  • Network name
  • Name of the developer(s)
  • Publication(s) describing the network, if any
  • Type of task carried by the network
  • Link to repository
  • Link to example training and test dataset

Note that we may not feature your network if it doesn't follow the points above or if we find a considerable issue with it.

Thank you in advance for your help and helping us make ZeroCostDL4Mic better =).

Engaging with the community

Join the discussions on GitHub issues and PRs. Share your experience and expertise. Help new users get started. The more people engaged, the better this resource becomes!

Authorship Expectations

The default way to recognize contributions is via the contributors section of the repository. The attribution of authorship to future publications derived from the ZeroCostDL4Mic project is not given "automatically" to contributors. Instead, it follows these guidelines:

  • Authorship roles and expectations are discussed early on in the project and ultimately decided by the senior project leads (Ricardo Henriques and Guillaume Jacquemet). This is often an ongoing conversation throughout the project, as roles and contributions may change over time.
  • All authors are expected to contribute significantly to the project. This includes conception, design, development of functionality, data acquisition, analysis and interpretation, and drafting and revising the manuscripts. These contributions are made with prior discussion and agreement of the senior project leads and core development team.

Code of Conduct

Please note that this project follows a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you for considering contributing to ZeroCostDL4Mic!

-The ZeroCostDL4Mic team-