Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9e58c3d

Browse files
authoredApr 15, 2024··
Merge branch 'source' into release-49
2 parents aac1a94 + b06b4ec commit 9e58c3d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+674
-115
lines changed
 

‎.github/create_newsletter_scaffold.sh

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#!/usr/bin/env bash
2+
3+
set -euo pipefail
4+
5+
if [[ -z "${NEWSLETTER_MONTH}" ]]; then
6+
echo "NEWSLETTER_MONTH is not set. Exiting..."
7+
exit 1
8+
fi
9+
10+
if [[ -z "${NEWSLETTER_YEAR}" ]]; then
11+
echo "NEWSLETTER_YEAR is not set. Exiting..."
12+
exit 1
13+
fi
14+
15+
if [[ -z "${NEWSLETTER_COUNTER}" ]]; then
16+
echo "NEWSLETTER_COUNTER is not set. Exiting..."
17+
exit 1
18+
fi
19+
20+
# NEWSLETTER_NEXT_MONTH_NUMBER
21+
if [[ -z "${NEWSLETTER_NEXT_MONTH_NUMBER}" ]]; then
22+
echo "NEWSLETTER_NEXT_MONTH_NUMBER is not set. Exiting..."
23+
exit 1
24+
fi
25+
26+
cp .github/newsletter-template.md index.md
27+
sed -i "s/{{\s*NEWSLETTER_MONTH\s*}}/${NEWSLETTER_MONTH}/g" index.md
28+
sed -i "s/{{\s*NEWSLETTER_YEAR\s*}}/${NEWSLETTER_YEAR}/g" index.md
29+
sed -i "s/{{\s*NEWSLETTER_COUNTER\s*}}/${NEWSLETTER_COUNTER}/g" index.md
30+
sed -i "s/{{\s*NEWSLETTER_NEXT_MONTH_NUMBER\s*}}/${NEWSLETTER_NEXT_MONTH_NUMBER}/g" index.md
31+
# Create a dir in content/news with the counter with 3 digits as name
32+
destination="content/news/$(printf "%03d" ${NEWSLETTER_COUNTER})"
33+
mkdir -p $destination
34+
mv index.md $destination/index.md
35+
git status

‎.github/newsletter-issue-template.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
title: "Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
3+
labels: coordination, help wanted
4+
assignees: AngelOnFira, mamaicode, janhohenheim
5+
---
6+
7+
**Editors:** @janhohenheim, @AngelOnFira, @mamaicode
8+
9+
Another month has gone by, so it's time to put together the Rust Gamedev newsletter with {{ env.NEWSLETTER_MONTH }}'s news!
10+
11+
## Current Schedule
12+
13+
The deadline for all section PRs is the **28th of {{ env.NEWSLETTER_MONTH}}, {{ env.NEWSLETTER_YEAR }}**. Submissions after this date will be added to the next newsletter.
14+
Our target release date is the **3rd of {{ env.NEWSLETTER_NEXT_MONTH }}, {{ env.NEWSLETTER_YEAR }}**.
15+
16+
## Current Structure & Status
17+
18+
Below is our current planned structure for the newsletter, and the status of each PR (which we'll try to keep updated).
19+
20+
This is **not** an exhaustive list - if you have your own project that you want to write about, just make a comment on this issue and open a PR!
21+
22+
### Game Updates
23+
24+
None yet. Feel free to submit yours!
25+
26+
### Learning Material Updates
27+
28+
None yet. Feel free to submit yours!
29+
30+
### Engine Updates
31+
32+
None yet. Feel free to submit yours!
33+
34+
### Tooling Updates
35+
36+
None yet. Feel free to submit yours!
37+
38+
### Library Updates
39+
40+
None yet. Feel free to submit yours!
41+
42+
### Other News
43+
44+
None yet. Feel free to submit yours!
45+
46+
### Discussions
47+
48+
None yet. Feel free to submit yours!
49+
50+
## Calls for Submissions
51+
52+
### Social Media
53+
54+
- [ ] Reddit
55+
- [ ] Lemmy
56+
- [ ] Mastodon
57+
- [ ] Twitter/X
58+
- [ ] Hacker News
59+
60+
### Discord Servers
61+
62+
- [ ] Rust GameDev
63+
- [ ] Bevy
64+
- [ ] Blue Engine
65+
- [ ] Macroquad
66+
- [ ] Fyrox
67+
- [ ] LogLogGames (comfy engine)
68+
- [ ] Spicy Lobster
69+
- [ ] Rust Godot
70+
71+
Let us know if you also want to receive monthly reminders on your Discord server!
72+
73+
## Publishing Steps
74+
75+
- [ ] Final review - by everyone
76+
- [ ] Publish - by @janhohenheim
77+
- [ ] Post together with next calls for submissions - by @janhohenheim
78+
- [ ] Pin thread on social media - by @janhohenheim
79+
- [ ] Add comment links - by @janhohenheim
80+
81+
## How to Contribute
82+
83+
If you want to help writing the newsletter:
84+
85+
- **Read [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z).**
86+
- Choose one or more of the "🆓 **free**" sections listed below, and leave a comment letting us know you want to work on them.
87+
- The links in brackets (like `[1](#), [2](#), [3](#)`) are suggestions of links to include in the section. Feel free to add more!
88+
- The username listed next to the section (like `@janhohenheim?`) is a suggestion of who may want to pick up the work (usually the project's developer, or someone who has expressed interest in the past).
89+
- You are not obligated to write a section if you're tagged or your project is listed! You're welcome to ask someone else to write the section, or to ask for your project to be excluded from this month's post.
90+
- Extra sections not listed in the plan are welcomed - just leave a comment and open a PR!
91+
- Write a short overview in the newsletter's Markdown file, making sure to follow the style guidelines (see below).
92+
- Send a PR [_to the `source` branch_](https://github.com/rust-gamedev/rust-gamedev.github.io/tree/source) (example PR: [N15: A/B Street #336](https://github.com/rust-gamedev/rust-gamedev.github.io/pull/336)).
93+
- Mention this issue in your PR's description to link it all together.
94+
95+
## Style Guidelines
96+
97+
The full style guide is in [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z),
98+
but here are the most important rules:
99+
100+
- Write in third-person perspective.
101+
- Each line must be 160 characters or less, for ease of reviewing/diffing.
102+
- Only one image per section is allowed.
103+
- The maximum size is 300kb for static images and 2.5mb for GIFs.
104+
- The image should come before the text, and must have alt text for accessibility.
105+
- Prefer static images to GIFs, to keep the page load times down.
106+
- Each section should be under 1000 characters, and under 6 paragraphs.
107+
- This only applies to the rendered text, not the markup.
108+
- Keep formatting minimal - no bold/italics/etc.
109+
- Avoid long/nested bullet point lists - no changelogs!
110+
111+
Please use these templates as a starting point:
112+
113+
**Games/apps/libraries:**
114+
115+
```md
116+
### [Game name]
117+
118+
![alt text](img)
119+
_optional image label_
120+
121+
[Game name] ([GitHub], [Discord], [Twitter]) by [@nickname]
122+
is... {short project description in one sentence}.
123+
124+
{An overview of the recent updates with links to more details}.
125+
126+
_Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
127+
128+
[Game name]: http://example.com
129+
```
130+
131+
**Articles/blog posts/videos/etc:**
132+
133+
```md
134+
### [Article name]
135+
136+
![alt text](img)
137+
_optional image label_
138+
139+
[@nickname] published an [article] about...
140+
{overview what the resource is about}.
141+
142+
_Discussions: [/r/rust_gamedev](link), [Twiter](link), [etc](link)_
143+
144+
[Article name]: http://example.com
145+
```

0 commit comments

Comments
 (0)
Please sign in to comment.