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

Fix documentation #1092

Merged
merged 2 commits into from
Jun 19, 2024
Merged

Fix documentation #1092

merged 2 commits into from
Jun 19, 2024

Conversation

sandro-elsweijer
Copy link
Collaborator

Describe your changes here:
The checkout action now needs a fetch-tags option to fetch the tags

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

  • The author added a BSD statement to doc/ (or already has one)

@sandro-elsweijer sandro-elsweijer added CI Continuous Integration fix labels Jun 19, 2024
@sandro-elsweijer sandro-elsweijer self-assigned this Jun 19, 2024
@sandro-elsweijer sandro-elsweijer marked this pull request as ready for review June 19, 2024 11:52
@sandro-elsweijer sandro-elsweijer removed their assignment Jun 19, 2024
@holke holke enabled auto-merge June 19, 2024 12:04
@holke holke merged commit 382b054 into main Jun 19, 2024
11 checks passed
@holke holke deleted the fix-documentation_workflow branch June 19, 2024 12:08
@Davknapp Davknapp linked an issue Jul 15, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doxygen docu not generating version number
2 participants