Home

This wiki collects practical tips and guidelines on how to contribute to aiida-core.
For documentation of AiiDA internals and writing AiiDA plugins, see the AiiDA documentation.

User wiki

• RabbitMQ version to use with AiiDA (<=3.8.14)

Contributor wiki - please read before making a pull request!

• Setting up your development environment
• Branch descriptions
• Coding style
• Writing tests
• Writing documentation
• Making a pull request
• Contributing gotchas

Maintainer wiki

• Git style requirements
• How to make a new release
• Issue triage
• AiiDA Dependency Management
• AiiDA Bot
• Best practises for code review
• Deprecations and API changes

Plugin developer wiki

• Testing plugin against latest AiiDA
• AiiDA 1.0 plugin migration guide
• AiiDA 2.0 plugin migration guide
• Writing a CalcJobImporter plugin

Core developer wiki

• Modifying the database schema

Useful resources

About AiiDA development

• AiiDA release roadmap
• AiiDA plugin registry
• Containers/VMs related to AiiDA and the AiiDA lab
• AiiDA @ Google Summer of Code

References

• Git cheatsheet
• How to migrate from BitBucket to GitHub
• RST tutorial for GitHub
• Tips on writing good documentation
• Optimising the SLURM scheduler configuration (for cluster administrators)