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

Create a developers guide #481

Closed
tim-vd-aardweg opened this issue Mar 24, 2023 · 2 comments · Fixed by #496
Closed

Create a developers guide #481

tim-vd-aardweg opened this issue Mar 24, 2023 · 2 comments · Fixed by #496
Assignees
Labels
type: documentation Improvements or additions to documentation
Milestone

Comments

@tim-vd-aardweg
Copy link
Contributor

tim-vd-aardweg commented Mar 24, 2023

What is the need for this task.
We need documentation for some common developers procedures/tasks. This documentation can also be useful for reviews.

What is the task?
Create a document where we can list guides and procedures for developers. Content can for example include:

  • Updating the __init__.py files if we change the public API.
  • Updating the dhydro_support_hydrolib-core.xlsx if new functionalities have been added.
    - How to test new models. (Should be done when we have refactored the parsers and serializers)
    -- When do we use files for test data and when do we use in-memory data.
@tim-vd-aardweg tim-vd-aardweg added type: documentation Improvements or additions to documentation chore labels Mar 24, 2023
@tim-vd-aardweg tim-vd-aardweg added this to the Release 0.5 milestone Mar 24, 2023
@tim-vd-aardweg tim-vd-aardweg self-assigned this Mar 24, 2023
@priscavdsluis
Copy link
Contributor

#16 can probably be closed with this issue.

@tim-vd-aardweg
Copy link
Contributor Author

As discussed during the standup:

  • I have removed the developers guide from the online documentation. It is now only a document that can be found in the repo.
  • The initial contents will remain as is. When we overhaul the documentation, we can see if items from the How to contribute page can be moved to the developers guide.
  • When we pick up the refactoring of the parsers and serializers (Refactor the parsers and serializers #503), we should add something about how we want to test parsers and serializers.

@MRVermeulenDeltares MRVermeulenDeltares self-assigned this Apr 7, 2023
tim-vd-aardweg added a commit that referenced this issue Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants