Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer guide documentation #181

Merged
merged 2 commits into from
Jul 9, 2024
Merged

Conversation

jbreue16
Copy link
Contributor

@jbreue16 jbreue16 commented Mar 18, 2024

We need to add a new section to our documentation to help developers with making contributions.

In this developer guide, we should give some information on 1) the codebase 2) how to make specific contributions, e.g. new binding models and unit operations 3) general best practices and requirements, e.g. (unit) tests.

Team members can add topics here.

Everybody please feel free to help expand this guide.

This PR is only meant to add the new section, including documentation on

This commits adds a developer guide section to the documentation, including documentation on model extension, debugging and testing procedures.
@jbreue16 jbreue16 force-pushed the chore/developer_guide branch from e58b4f1 to 4626fdf Compare June 20, 2024 13:30
Copy link
Contributor

@schmoelder schmoelder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor comments, otherwise, LGTM

@jbreue16 jbreue16 mentioned this pull request Jul 9, 2024
3 tasks
@ronald-jaepel ronald-jaepel merged commit b2d9d63 into master Jul 9, 2024
3 checks passed
@ronald-jaepel ronald-jaepel deleted the chore/developer_guide branch July 9, 2024 14:19
@ronald-jaepel ronald-jaepel restored the chore/developer_guide branch July 9, 2024 14:19
@github-actions github-actions bot locked and limited conversation to collaborators Jul 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add developer guide to documentation
3 participants