-
Notifications
You must be signed in to change notification settings - Fork 28
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
Conversation
This file contains 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
a08999e
to
07e904c
Compare
This was referenced Mar 22, 2024
Merged
07e904c
to
140f662
Compare
3f3ff1a
to
e58b4f1
Compare
This commits adds a developer guide section to the documentation, including documentation on model extension, debugging and testing procedures.
e58b4f1
to
4626fdf
Compare
schmoelder
reviewed
Jun 20, 2024
schmoelder
reviewed
Jun 20, 2024
schmoelder
reviewed
Jun 20, 2024
schmoelder
requested changes
Jun 20, 2024
There was a problem hiding this 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
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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
fixes Add developer guide to documentation #166