cloud-native-toolkit / cloud-native-toolkit/planning

The template repos need the License file to be in the root directory

Open
#826 2 comments 0 reactions 1 assignee Claimed by @seansund View on GitHub
Dominant language
No language data
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Description

In #779 and #731, when we moved the license file to the `licenses` directory the way Red Hat wants, we messed up what GitHub wants. GitHub displays the license for a repo, if any, but only if it is a file named LICENSE or LICENSE.md (with all caps) in the root directory. So we need to have that license file in both the root directory (for GitHub) and in the licenses directory (for Red Hat).

This means we need to put a license file back in the root directory in these templates:
- IBM/template-java-spring
- IBM/template-node-typescript
- IBM/template-graphql-typescript
- IBM/template-node-react
- IBM/template-node-angular

[Adding a license to a repository](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) explains how this works in GitHub.

The Quarkus template has not been modified. GitHub displays it like this, which indicates the license:
![image.png](https://images.zenhubusercontent.com/5e3056667bf0faadc9f1a0fa/138ddd06-af32-4986-ab49-c55a817d8192)

The React template has been modified. GitHub now displays it like this, with no indication of any license:
![image.png](https://images.zenhubusercontent.com/5e3056667bf0faadc9f1a0fa/b75b6a88-6681-421d-96b8-fb00f977e38e)

Thanks to Mark Sturdevant for discovering this problem.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.