Skip to content

Commit

Permalink
[chore][CONTRIBUTING.md] Add reference to addlicense command (#33635)
Browse files Browse the repository at this point in the history
When adding new components, new files are introduced. These files need
to include the license header, which is done by running the `make
addlicense` commnand. This should be documented for users to know what
they need to do when introducing new components and files.

Also, [here's an
example](#33458 (comment))
where it wasn't obvious that this command was necessary.
  • Loading branch information
crobert-1 authored Jun 18, 2024
1 parent 6dd3bae commit 0ce625a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ When submitting a component to the community, consider breaking it down into sep
* `make generate`
* `make multimod-verify`
* `make generate-gh-issue-templates`
* `make addlicense`
* **Second PR** should include the concrete implementation of the component. If the
size of this PR is larger than the recommended size consider splitting it in
multiple PRs.
Expand Down

0 comments on commit 0ce625a

Please sign in to comment.