📚 Add developer guide from wiki content#7215
Open
GeigerJ2 wants to merge 23 commits intoaiidateam:mainfrom
Open
📚 Add developer guide from wiki content#7215GeigerJ2 wants to merge 23 commits intoaiidateam:mainfrom
GeigerJ2 wants to merge 23 commits intoaiidateam:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7215 +/- ##
==========================================
- Coverage 79.86% 79.86% -0.00%
==========================================
Files 566 566
Lines 43925 43925
==========================================
- Hits 35077 35075 -2
- Misses 8848 8850 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Closed
This was referenced Feb 16, 2026
Closed
54d0609 to
5a13cd5
Compare
Revive the `docs/source/developer_guide/` section (previously excluded from the Sphinx build) with content migrated from the GitHub wiki. Add AGENTS.md and CONTRIBUTING.md at the repo root.
01f937d to
b3f5f3d
Compare
khsrali
reviewed
Mar 25, 2026
|
|
||
| Saw a typo in the documentation? Want to improve the code? | ||
| Help is always welcome, get started with the `contributing guidelines <https://github.com/aiidateam/aiida-core/wiki>`__. | ||
| Help is always welcome, get started with the :doc:`developer guide <developer_guide/index>`. |
Collaborator
There was a problem hiding this comment.
I agree it makes sense to have this as part of docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
NOTE: Merge after #7265.
Rendered view:
https://aiida--7215.org.readthedocs.build/projects/aiida-core/en/7215/developer_guide/index.html
The content from the wiki moved into the previously existing (but excluded from the docs build)
docs/source/developer_guidewith the help of Claude Code. Some outdated information was already removed (see below).Everything manually verified, updated, and brought up to speed with current practices and our technical setup.
The overall structure and content is as follows. I already pinged people who might potentially have a say in each section (assuming nobody wants to go through the whole thing, even though I think it's quite informative now, so please be my guest, if so =):
Contributing
development_environment.md@danielhollasuv sync), environment isolation (profiles, worktrees, Docker), running tests, pre-commit hooks, WSL, usefulverdicommandscoding_style.md@danielhollas, @mbercxwriting_tests.md@khsraliwriting_documentation.md@khsrali @mbercxpull_requests.md@agoscinskicode_review.md@agoscinskiMaintainer guides
deprecations.md@mbercxdependency_management.md@danielhollasdatabase_schema.md@mbercxreleases.md@mbercxissue_triage.md@agoscinskiCore internals
internals.md@mbercxdesign_evolution.md@mbercxRemoved outdated content
__future__imports guidance, Python 2/3 dual support instructions