Skip to content

Contribution Guidelines

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

Ensure your pull request adheres to the following guidelines:

  • Search the main page and previous suggestions before making a new one, as yours may be a duplicate.
  • Add your links like: * [project-name](http://example.com) - A short description ends with a dot.
  • If possible, input the web domain names only, as links to the particular web-pages may expire.
  • Make a remark proprietary if the content is not freely available.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.

When opening a pull request, enter a short description of the project. The autonomy level (fully autonomous vs. manual intervention) of various categories is shown via emoji. See https://github.com/sgbaird/awesome-self-driving-labs#emoji-key for an emoji key, and see other entries for usage. Some examples:

  • 🧪🔬🏗️💻 Fully autonomous
  • 🧪🔬✖️💻 Manual sample transfer
  • 🧪✖️✖️💻 Automated synthesis and AI planning
  • 🧪✖️✖️✖️ Automated synthesis
  • ✖️✖️✖️💻 Manual experiments with AI planning
  • ✖️✖️✖️✖️ Fully manual

If you're unsure of some (or all) emoji labels, then use❔; please clarify whether this is because you're unsure if the info is available vs. you're certain the info is not there. Either is fine; all contributions are welcome! In the former case, we'll do our best to do the sifting and assign the appropriate label. An example:

  • 🧪🔬❔💻 means fully autonomous, except unsure about sample transfer

Also, manuscript citations follow this general format (volume, issue, and page numbers optional):

[Title](https://doi.org/<doi>). Last, F.; Last, F.; ... ; Last, F. *Journal* YYYY, # (#), #–#.

For example: - 🧪🔬🏗️💻 | A Self-Driving Laboratory Designed to Accelerate the Discovery of Adhesive Materials. Rooney, M. B.; MacLeod, B. P.; Oldford, R.; Thompson, Z. J.; White, K. L.; Tungjunyatham, J.; Stankiewicz, B. J.; Berlinguette, C. P. Digital Discovery 2022.

Thank you for your suggestions!

Creating a pull request

See the video below for an easy-to-follow demonstration.

  1. Fork the repository
  2. Create a new branch for your addition
  3. Make a pull request in which you add short description of why the project/resource/tool is awesome.

https://github.com/sgbaird/awesome-self-driving-labs/assets/45469701/68e0b7b3-bd58-4c71-a1fe-ab108b168722

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.

Discussions

Check out existing discussions or create a new discussion.

Credits

This contribution guide is based on the ones from awesome-chemistry-datasets and awesome-materials-informatics.