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

Revise README.md #325

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revise README.md #325

wants to merge 1 commit into from

Conversation

gerlero
Copy link
Owner

@gerlero gerlero commented Mar 4, 2025

As part of openjournals/joss-reviews#7633, make the following proposed changes to the README file.

From #317 (comment):

  • README: add statement of need.
  • README/REPO: add clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
  •  README/REPO: in contributing section, mention how to run the tests locally.

From #318 (comment):

  • README: mention hardware used to get the speedup plot.

From #318 (comment):

  • REPO/README: Add benchmark code for comparison between foamlib and PyFoam.

@codecov-commenter
Copy link

codecov-commenter commented Mar 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.07%. Comparing base (9627c72) to head (bd7f990).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #325   +/-   ##
=======================================
  Coverage   87.07%   87.07%           
=======================================
  Files          15       15           
  Lines        1408     1408           
=======================================
  Hits         1226     1226           
  Misses        182      182           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gerlero gerlero force-pushed the readme branch 7 times, most recently from e921148 to b98033a Compare March 5, 2025 19:14
@AndreWeiner
Copy link

AndreWeiner commented Mar 6, 2025

@gerlero I am somehow missing the contribution guidelines and test instructions in this PR, even though they are marked as checked...

@gerlero
Copy link
Owner Author

gerlero commented Mar 6, 2025

@AndreWeiner sorry, I somehow forgot to make the final push. It should be fixed now.

@AndreWeiner
Copy link

@gerlero green light for this PR from my side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants