Skip to content

Commit a284821

Browse files
committed
docs: point new contributors to good first issues
Link the good first issue and help wanted lists from the README and the contribution guide, and show the open good first issue count as a README badge. Run Dependabot version updates monthly instead of weekly so dependency pull requests stay few. Security updates do not follow this schedule.
1 parent 07a2251 commit a284821

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
version: 2
2+
# Version updates run monthly so dependency pull requests stay few. Security
3+
# updates, when enabled in the repository settings, do not follow this schedule.
24
updates:
35
- package-ecosystem: npm
46
directory: /
57
schedule:
6-
interval: weekly
7-
day: monday
8+
interval: monthly
89
open-pull-requests-limit: 5
910
# Minor and patch updates arrive as one pull request per dependency type.
1011
# Major updates keep their own pull requests so breaking changes are reviewed
@@ -35,8 +36,7 @@ updates:
3536
- package-ecosystem: github-actions
3637
directory: /
3738
schedule:
38-
interval: weekly
39-
day: monday
39+
interval: monthly
4040
open-pull-requests-limit: 5
4141
groups:
4242
github-actions:

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ documentation, accessibility improvements, original questions, and clear bug rep
66
## Find a useful change
77

88
- Read the [project overview](README.md) and [documentation index](docs/README.md).
9+
- New to the project? Pick an issue labelled
10+
[good first issue](https://github.com/procoderji-com/procoderji/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22).
11+
Each one names the files to change and the checks to run. Issues labelled
12+
[help wanted](https://github.com/procoderji-com/procoderji/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22help%20wanted%22)
13+
are larger.
914
- Check existing [issues](https://github.com/procoderji-com/procoderji/issues) and
1015
[pull requests](https://github.com/procoderji-com/procoderji/pulls) before starting.
1116
- Discuss larger features, paid features, data collection, or dependency changes in an issue first.

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@
88

99
A student learning workspace with original practice questions, explanations, and saved progress.
1010

11-
[Website](https://procoderji.com) · [Documentation](docs/README.md) · [Roadmap](https://github.com/procoderji-com/procoderji/issues/22) · [Report a bug](https://github.com/procoderji-com/procoderji/issues/new?template=bug_report.yml) · [Propose a question](https://github.com/procoderji-com/procoderji/issues/new?template=practice_question.yml)
11+
[Website](https://procoderji.com) · [Documentation](docs/README.md) · [Roadmap](https://github.com/procoderji-com/procoderji/issues/22) · [Good first issues](https://github.com/procoderji-com/procoderji/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22) · [Report a bug](https://github.com/procoderji-com/procoderji/issues/new?template=bug_report.yml) · [Propose a question](https://github.com/procoderji-com/procoderji/issues/new?template=practice_question.yml)
1212

1313
[![CI](https://github.com/procoderji-com/procoderji/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/procoderji-com/procoderji/actions/workflows/ci.yml)
1414
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1515
[![Next.js](https://img.shields.io/badge/Next.js-16-black?logo=next.js)](https://nextjs.org/)
1616
[![TypeScript](https://img.shields.io/badge/TypeScript-5-blue?logo=typescript)](https://www.typescriptlang.org/)
17+
[![Good first issues](https://img.shields.io/github/issues/procoderji-com/procoderji/good%20first%20issue?label=good%20first%20issues&color=7057ff)](https://github.com/procoderji-com/procoderji/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22)
1718

1819
</div>
1920

0 commit comments

Comments
 (0)