Skip to content

Improve contributor experience with CI #13896

Open
@serathius

Description

@serathius
  • In CONTRIBUTING.md, list scripts in scripts/ that a first-time contributor would need (and what they're for). Or - have a short explanation at the top of each script which briefly says what it's for. (Doesn't have to be a full usage guide, just "Updates license information in modules and submodules. CI checks that running this causes no changes." would go a long way)
  • For CI failures, suggest the appropriate script to fix the corresponding failure. For example, if the bom test fails, most likely the contributor just needs to run ./scripts/fix.sh

With introduction of make test-* make verify-* and make fix-* I would propose to split ./scripts/test.sh to separate targets and document them all in makefile. Having a fix-* target for each verify-* should address the issue.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions