Skip to content

Commit 2a65ed8

Browse files
committed
Improve catalog navigation and contributions
1 parent bad1aef commit 2a65ed8

10 files changed

Lines changed: 776 additions & 42 deletions

File tree

.github/pull_request_template.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1+
## Suggestion type
2+
3+
- [ ] Project
4+
- [ ] Resource
5+
6+
## Checklist
7+
8+
- [ ] I searched the list and existing issues for duplicates.
19
- [ ] I changed `README_SOURCE.md`, not the generated `README.md`.
210
- [ ] This pull request contains one suggestion.
3-
- [ ] Java is a primary API, runtime, target or first-class integration.
4-
- [ ] I used the canonical GitHub repository when one exists.
5-
- [ ] The concise, neutral description explains the distinguishing value and ends with punctuation.
6-
- [ ] Commercial or restrictive licensing is disclosed where applicable.
11+
- [ ] The suggestion is relevant to Java or the JVM and fits its chosen category.
12+
- [ ] I used the canonical project or resource link.
13+
- [ ] The suggestion is current and maintained.
14+
- [ ] The concise, neutral description explains its distinguishing value and ends with punctuation.
15+
- [ ] Licensing is clear and any restrictive terms are disclosed where applicable.

.github/workflows/update-readme.yml

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
# SPDX-License-Identifier: MIT
2+
13
name: Update README
24

35
on:
46
pull_request:
57
paths:
68
- "README_SOURCE.md"
9+
- "README.md"
710
- "CONTRIBUTING.md"
811
- ".github/pull_request_template.md"
912
- ".github/workflows/update-readme.yml"
@@ -27,14 +30,25 @@ permissions:
2730

2831
concurrency:
2932
group: update-readme-${{ github.ref }}
30-
cancel-in-progress: false
33+
cancel-in-progress: true
3134

3235
jobs:
3336
validate:
3437
if: github.event_name == 'pull_request'
3538
runs-on: ubuntu-latest
3639
steps:
3740
- uses: actions/checkout@v6
41+
with:
42+
fetch-depth: 0
43+
- name: Reject direct README changes
44+
env:
45+
BASE_SHA: ${{ github.event.pull_request.base.sha }}
46+
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
47+
run: |
48+
if ! git diff --quiet "$BASE_SHA" "$HEAD_SHA" -- README.md; then
49+
echo "::error file=README.md::README.md is generated. Edit README_SOURCE.md instead."
50+
exit 1
51+
fi
3852
- uses: actions/setup-java@v5
3953
with:
4054
distribution: temurin
@@ -79,8 +93,8 @@ jobs:
7993
java scripts/GenerateReadme.java generate README_SOURCE.md README.md .cache/github-stats.tsv "${args[@]}" --branch "$GITHUB_REF_NAME"
8094
- name: Commit README
8195
run: |
82-
git config --local user.email "action@github.com"
83-
git config --local user.name "GitHub Action"
96+
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
97+
git config --local user.name "github-actions[bot]"
8498
git add README.md
8599
if git diff --staged --quiet; then
86100
echo "README is already current"

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
.vscode/
33
.tmp/
44
.cache/
5+
.DS_Store
6+
*.class

CONTRIBUTING.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,26 @@ Search existing entries and issues before submitting. Self-promotion is
3131
reviewed carefully but is welcome when the project meets the same criteria.
3232
Use one pull request per project.
3333

34+
## Suggest a Resource
35+
36+
Add one resource under the best group in [`README_SOURCE.md`](README_SOURCE.md):
37+
38+
```markdown
39+
- [Resource Name](https://canonical.example)
40+
```
41+
42+
An optional description may follow the link:
43+
44+
```markdown
45+
- [Resource Name](https://canonical.example) - A concise, neutral description ending with punctuation.
46+
```
47+
48+
Resources include books, podcasts, people, communities, related lists and
49+
websites. They must be current, relevant to Java or the JVM, use a canonical
50+
HTTPS link, fit the chosen group and use English where prose is involved.
51+
Search for duplicates and submit one resource per pull request. Contributors
52+
do not need to run the generator.
53+
3454
## Maintainer Notes
3555

3656
Most entries point directly to one GitHub repository. For an umbrella project
@@ -43,5 +63,13 @@ homepage and append maintainer-only metadata:
4363

4464
Use at least two canonical repositories. A repository may belong to only one
4565
entry. The generator sums their stars, uses their most recent push for activity
46-
and rejects malformed metadata, duplicate repository use and archived
66+
and shows a license only when every repository reports the same SPDX license.
67+
It rejects malformed metadata, duplicate repository use and archived
4768
repositories.
69+
70+
## License
71+
72+
Catalog and documentation contributions are licensed under
73+
[CC BY-SA 4.0](LICENSE). Automation code and configuration are licensed under
74+
the [MIT License](LICENSE-CODE). By contributing, you agree that your changes
75+
are available under the applicable license.

0 commit comments

Comments
 (0)