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

Update README.md to reflect new modernization checks #23

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

alvrogd
Copy link
Collaborator

@alvrogd alvrogd commented Jun 10, 2024

In recent updates, including #14, #15, #16, #17, #18, #20, several new modernization checks were introduced to the Open Catalog. While some modernization checks have been part of the Catalog for some time, their importance has significantly
increased recently.

Consequently, we're updating the repository description to highlight two primary areas of focus: modernization and optimization.

Additionally, I've taken the opportunity to enhance a bit the readability of the existing text.

@alvrogd alvrogd self-assigned this Jun 10, 2024
@alvrogd alvrogd requested review from a team, d-alonso, igarcia0, ruifm, jgonzac, daniel-otero and inaki-amatria and removed request for a team June 10, 2024 14:49
Copy link
Contributor

@inaki-amatria inaki-amatria left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

README.md Outdated
Fortran programming languages. The Catalog consists of a comprehensive set of
checks (rules) that describe specific issues in the source code and provide
guidance on corrective actions, along with extensive documentation, example
codes, and references to additional reading resources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
codes, and references to additional reading resources.
codes and references to additional reading resources.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

README.md Outdated
This catalog includes [a suite of microbenchmarks](Benchmark/README.md) that
demonstrate the potential performance improvement that can be attained by
applying the fixes that are suggested for each check.
The Catalog includes [a suite of microbenchmarks](Benchmark/README.md) designed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe?

Suggested change
The Catalog includes [a suite of microbenchmarks](Benchmark/README.md) designed
The Open Catalog includes [a suite of microbenchmarks](Benchmark/README.md) designed

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

In recent updates, several new modernization checks were introduced
to the Open Catalog. While some modernization checks have been part
of the Catalog for some time, their importance has significantly
increased recently.

Consequently, we're updating the repository description to highlight
two primary areas of focus: modernization and optimization.

Additionally, I've taken the opportunity to enhance a bit the
readability of the existing text.
@alvrogd alvrogd force-pushed the feature/UpdateCatalogDescription branch from 6a620d8 to db71c11 Compare June 11, 2024 08:34
@alvrogd alvrogd merged commit db71c11 into main Jun 11, 2024
3 checks passed
@alvrogd alvrogd deleted the feature/UpdateCatalogDescription branch June 11, 2024 08:39
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.

4 participants