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

Apply the Beman Standard rules related to the Beman Library Maturity Model #114

Merged
merged 6 commits into from
Feb 20, 2025

Conversation

neatudarius
Copy link
Member

@neatudarius neatudarius commented Feb 7, 2025

Last update in this repo after bemanproject/beman#77

Copy link
Contributor

@bretbrownjr bretbrownjr left a comment

Choose a reason for hiding this comment

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

No objections here. I'm happy to see the progress moving along productively.

@neatudarius neatudarius marked this pull request as ready for review February 18, 2025 17:06
@neatudarius
Copy link
Member Author

neatudarius commented Feb 18, 2025

Incidentally, is there a reason we're not using a badges service like https://shields.io/?

We'll still end-up having CI badges - e.g. https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg, which is basically the general case. The library status is one-time only (one occurrence). So I think your suggestion don't solve the issue.

CC: @bretbrownjr

LE.

Also, the other proposes solution , this fails the linter (and it will fail anyways when we'll have 5-10 badges :D.

dariusn ~/dev/dn/git/Beman/exemplar [run_beman-tidy] $ git diff .
diff --git a/README.md b/README.md
index 9106668..9657c8e 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@
 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 -->
 
-<!-- markdownlint-disable-next-line line-length -->
-![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg)
+[under-development]: https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg
+
+![Library Status][under-development] ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg)
 
 `beman.exemplar` is a minimal C++ library conforming to [The Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md).
 This can be used as a template for those intending to write Beman libraries.
dariusn ~/dev/dn/git/Beman/exemplar [run_beman-tidy] $ markdownlint -f .
README.md:9:120 MD013/line-length Line length [Expected: 119; Actual: 263]

Copy link
Member

@JeffGarland JeffGarland left a comment

Choose a reason for hiding this comment

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

This looks like it's ready to move forward - approving.

@wusatosi
Copy link
Member

Also, the other proposes solution , this fails the linter (and it will fail anyways when we'll have 5-10 badges :D.

I think that will be a good time to

  1. update the beman tidy script to account for this, so we can actually put the badges once per line
  2. Rethink why we need 5-10 badges.

Copy link
Member

@wusatosi wusatosi left a comment

Choose a reason for hiding this comment

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

All concerns addressed.

Thanks for the work @neatudarius .

@bretbrownjr bretbrownjr merged commit 3ea0d6c into main Feb 20, 2025
128 checks passed
@bretbrownjr bretbrownjr deleted the run_beman-tidy branch February 20, 2025 20:57
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