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

Unsatisfactory representation of project state in README badges #102

Closed
toonarmycaptain opened this issue Dec 30, 2018 · 1 comment
Closed
Labels
Documentation Documentation related issues Testing/CI Testing configuration issues

Comments

@toonarmycaptain
Copy link
Owner

Currently (pre merging some not insignificant and insufficiently tested (indeed, test breaking) features from dev to master all the badges in the master branch, except circleci's, look good. Circleci's badge shows a fail because the commit setting it up hasn't made it to the master branch yet.

Simply having branches display their own analysis and build/coverage results would be ideal, but evidently while requested, such a feature is not forthcoming.

It might be nice to get a better picture of the overall health of the repo, in particular the development branch, in the master README on the front page on the repo. Displaying an array eg master, development, big-feature-or-redeaign-currently-in-developmsnt branches

This way, when master is bad but dev is good, this will be evident eg fix is nearly in. When dev needs help, eg badly needing tests or rewritten tests die to new features in dev, the deficient coverage will be evident and the need clearly displayed on the front page of the repo. This is good whether it's test coverage, code smells, related code needing refactoring etc, without explicit issues needed for every problem spotted by a linter or code review analysis before they get attention.

@toonarmycaptain toonarmycaptain added Testing/CI Testing configuration issues Documentation Documentation related issues labels Dec 30, 2018
@toonarmycaptain
Copy link
Owner Author

GitMate.io thinks a possibly related issue is #89 (Improve README).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues Testing/CI Testing configuration issues
Projects
None yet
Development

No branches or pull requests

1 participant