Skip to content

Commit 3f6c8df

Browse files
authored
Merge pull request #2 from Mahmoudz/copilot/add-community-automation-files
Add community and automation infrastructure
2 parents 014f1b6 + ae626ca commit 3f6c8df

File tree

6 files changed

+133
-18
lines changed

6 files changed

+133
-18
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Report broken link
3+
about: Report a broken or outdated resource link
4+
title: "[broken link] "
5+
labels: broken-link
6+
---
7+
8+
Please provide:
9+
10+
- Resource name / URL:
11+
- Location in repo (e.g., README → Databases):
12+
- Short note about the problem:
13+
- Suggested replacement (if any):

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1-
# Pull Request Template for Awesome Topics
1+
<!-- Use this template for adding or updating resources -->
22

3-
## PR Type
4-
- New Topic
5-
- Edit Topic
6-
- New Subject
7-
- Design Enhancement
3+
## Type of change
4+
- [ ] Add a resource
5+
- [ ] Update a resource
6+
- [ ] Fix a broken link
7+
- [ ] Reorganize categories
88

99
## Description
10-
Please provide a concise summary of your changes or the new topic you are introducing.
10+
- Category:
11+
- Resource name:
12+
- URL:
13+
- One-line description (20–120 chars):
14+
- Tags (format: category, language, difficulty, license):
1115

1216
## Checklist
13-
- [ ] I have read the project's [Contributing Guide](CONTRIBUTING.md).
14-
- [ ] I have adhered to the project's quality standards.
15-
- [ ] I have ensured there is no duplicate content in my submission.
16-
- [ ] I have reviewed all open PRs to confirm no similar contributions are pending.
17-
- [ ] I have updated the Table of Contents (if necessary).
18-
19-
## Related Issue
20-
Link any related issues or discussions here.
21-
22-
## Additional Notes
23-
Add any other context or screenshots about the PR here.
17+
- [ ] I checked for duplicates.
18+
- [ ] Description and tags included.
19+
- [ ] Links tested and working (or note provided).
20+
- [ ] I followed the project contribution format.

.github/workflows/awesome-lint.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Awesome lint
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
7+
jobs:
8+
lint:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: '20'
18+
- name: Install awesome-lint
19+
run: |
20+
npm install -g awesome-lint
21+
- name: Run awesome-lint
22+
run: |
23+
awesome-lint README.md

.github/workflows/link-check.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Link check
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
schedule:
9+
- cron: '0 2 * * 1' # weekly on Monday UTC
10+
11+
jobs:
12+
markdown-link-check:
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: read
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '20'
22+
- name: Install markdown-link-check
23+
run: |
24+
npm install -g markdown-link-check
25+
- name: Run link checks on markdown files
26+
run: |
27+
find . -name '*.md' -not -path './node_modules/*' -print0 | xargs -0 -n1 markdown-link-check -q

CODE_OF_CONDUCT.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Code of Conduct (summary)
2+
3+
This project aims to be welcoming and inclusive. All contributors and visitors are expected to follow these basic guidelines.
4+
5+
Be respectful
6+
- Be professional and courteous. Assume good intent.
7+
- Do not engage in harassment, hate speech, or personal attacks.
8+
9+
Be constructive
10+
- Focus feedback on the content and the facts.
11+
- When possible, suggest improvements rather than only pointing out problems.
12+
13+
Reporting
14+
- If you encounter unacceptable behavior, please open an issue with the title "CODE OF CONDUCT report" or contact a repository maintainer via GitHub.
15+
- Reports will be handled respectfully and promptly by project maintainers or community moderators.
16+
17+
Enforcement
18+
- Responses may include a request to stop, moderation of content, or removal from the project for serious violations.
19+
20+
This is a short, community-friendly code of conduct. You can replace or expand it with the full Contributor Covenant text if you prefer.

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to awesome-topics
2+
3+
Thanks for helping improve this curated map for developers — contributions from anyone are welcome.
4+
5+
What to add
6+
- Ensure the resource is high-quality, relevant to software engineering or developer learning, and not already listed.
7+
- Proposed entry format (in a single list line):
8+
- [Name](URL) — Short neutral description. (tags)
9+
- Example: `- [Free Coding Course](https://example.com) — A beginner-friendly course on web fundamentals. (category:learning, language:js, difficulty:beginner)`
10+
11+
Tags
12+
- Use simple tags in parentheses after the description. Common tags: category, language, difficulty, license.
13+
- Tags help readers filter the list and let scripts export machine-readable data.
14+
15+
How to contribute
16+
1. Open a pull request that adds or updates entries in the README under the appropriate section.
17+
2. Keep changes focused and small (one logical change per PR is ideal).
18+
3. If your change is large (reorganizing many items or adding whole learning paths), open an issue first to discuss structure.
19+
20+
Pull request checklist (for contributors)
21+
- [ ] I checked for duplicates.
22+
- [ ] The entry has a short description and tags.
23+
- [ ] Links work (or a note explains a known issue).
24+
- [ ] Changes are limited to the intended section.
25+
26+
Review & maintenance
27+
- This project is community-maintained. Anyone can review and suggest improvements.
28+
- There is no fixed review deadline — maintainers and community members will triage and review PRs as available.
29+
- If you want to take responsibility for a category, mention it in an issue or comment and the community can coordinate.
30+
31+
Automation & formatting
32+
- Try to keep list formatting consistent (Markdown list items).
33+
- Consider running markdown linters locally before opening large PRs.
34+
35+
Thanks — your contribution helps other developers find better resources.

0 commit comments

Comments
 (0)