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

2020-12-3: make check and linter errors are unclear #238

Open
2 tasks
baileythegreen opened this issue Dec 3, 2020 · 0 comments
Open
2 tasks

2020-12-3: make check and linter errors are unclear #238

baileythegreen opened this issue Dec 3, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@baileythegreen
Copy link
Contributor

The errors produced by the make check and the yamllint CI checks are unclear to anyone who either did not write those files, or who has not already devoted some time into understanding what those files do.

I propose:

  • Adding informative errors to their output. This is easy to do in Python, so I think could be incorporated into the utils/check-glossary.py script fairly easily. This would at least help with some of this.
  • Adding some information about the CI to the contributing documents, explaining the types of things that are checked, summarising the errors that are likely to arise, and what might cause them.

Both of these things will make it easier for more people to contribute to this project confidently, without needing to be comfortable debugging multiple kinds of programs to get their PRs to pass the checks.

@baileythegreen baileythegreen added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request and removed bug Something isn't working labels Dec 3, 2020
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant