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 participating groups to README/docs #1989

Closed
wants to merge 8 commits into from

Conversation

sloede
Copy link
Member

@sloede sloede commented Jun 22, 2024

Supersedes #1880.

Note I also fixed a few discrepancies between the README and the docs.

Supersedes #1880.

Note I also fixed a few discrepancies between the README and the docs.
Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

README.md Show resolved Hide resolved
@sloede sloede changed the title WIP: Add participating groups to README/docs Add participating groups to README/docs Jun 25, 2024
@sloede sloede marked this pull request as ready for review June 25, 2024 06:31
@sloede sloede requested a review from ranocha June 25, 2024 06:31
README.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
@jmark
Copy link
Contributor

jmark commented Jun 25, 2024

I think the DLR also has a fair share in the development and should be mentioned as participating group:

[Dept. of High-Performance Computing, Institute of Software Technology, German Aerospace Center (DLR) :de:](https://www.dlr.de/en/sc/about-us/departments/high-performance-computing)

README.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
@sloede sloede requested a review from jmark June 25, 2024 09:47
jmark
jmark previously approved these changes Jun 25, 2024
@sloede sloede requested a review from ranocha June 25, 2024 10:28
ranocha
ranocha previously approved these changes Jun 25, 2024
docs/src/index.md Outdated Show resolved Hide resolved
@sloede sloede dismissed stale reviews from ranocha and jmark via 86a878a June 26, 2024 17:38
@sloede sloede mentioned this pull request Jun 26, 2024
@ranocha ranocha added the documentation Improvements or additions to documentation label Jul 2, 2024
@torrilhon
Copy link
Contributor

As discussed some time ago, I think, it should be my pull-request #1880 that is being merged, I already incorporated the suggestions of Michael.

docs/src/index.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
@sloede
Copy link
Member Author

sloede commented Dec 2, 2024

Superseded by #2187

@sloede sloede closed this Dec 2, 2024
@sloede sloede deleted the msl/add-participating-groups branch December 2, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants