Using Shared Code
How to use code from the AAGI shared code database responsibly.
How can shared code be used?
In the spirit of open science, we encourage the use of AAGI shared code in your projects. We only ask users to respect the licenses set by the code contributors. Below are some general guidelines for using shared code from our database.
Guidelines for using shared code
Check the License: Before using any code, check the license under which it is shared. This will inform you of how you can use, modify, and distribute the code. Common licenses include MIT, GPL, and Apache, each with its own terms. To learn more about different licenses, you can visit Choose a License.
Give Credit: If you use code from the database, make sure to give proper credit to the original authors. We encourage to reach out to the code owner(s) to let them know how their code will be used and to ask if they would like to be acknowledged in a specific way. These conversations can help foster collaboration and ensure that contributions are recognised appropriately. This can be done by citing the code in your project documentation, including a note in your code comments or acknowledging the code maintainer(s) in an acknowledgement/contributions section of your report.
Follow Best Practices: When using shared code, it’s important to follow best practices for coding and documentation. This includes writing clear comments, maintaining the integrity of the original code, and ensuring that any modifications you make are well-documented.
If you’ve made updates to code from the database, we’d love to include them. See Contribute for how to share your changes back.