Skip to content

Commit c6992da

Browse files
committed
Refactor issue template
1 parent 35c9f05 commit c6992da

File tree

1 file changed

+63
-60
lines changed

1 file changed

+63
-60
lines changed

Diff for: .github/newsletter-issue-template.md

+63-60
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,111 @@
11
---
2-
title: "N{{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
2+
title: "Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
33
labels: coordination, help wanted
4+
assignees: janhohenheim
45
---
56

6-
# Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}
7-
87
###### tags: `newsletter`
98

109
**Editors:**
1110

12-
Another month has gone by, so it's time to put together the Rust Gamedev newsletter with {{ env.NEWSLETTER_MONTH }}'s news!
11+
Another month has gone by, so it's time to put together the Rust Gamedev
12+
newsletter with {{ env.NEWSLETTER_MONTH }}'s news!
1313

1414
## Current Schedule
1515

16-
**The deadline for all section PRs is the 03.{{ env.NEWSLETTER_DEADLINE }}**
16+
The deadline for all section PRs is the **03.{{ env.NEWSLETTER_DEADLINE }}**
1717

18-
We _may_ still accept PRs that are submitted later than this, as long as they're ready before the newsletter's release, but this isn't guaranteed. If you want your section to be included, don't leave it till the last minute!
18+
We _may_ still accept PRs that are submitted later than this, as long as they're
19+
ready before the newsletter's release, but this isn't guaranteed.
20+
If you want your section to be included, don't leave it till the last minute!
1921

2022
## Current Structure & Status
2123

22-
Below is our current planned structure for the newsletter, and the status of each PR (which we'll try to keep updated).
23-
24-
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!
24+
Below is our current planned structure for the newsletter,
25+
and the status of each PR (which we'll try to keep updated).
2526

26-
#### Rust Gamedev Meetup
27+
This is **not** an exhaustive list - if you have your own project that you want
28+
to write about, just make a comment on this issue and open a PR!
2729

28-
* [ ] Details of this month's meetup - 🆓 **free** (@AngelOnFira @ozkriff?)
30+
### Game Updates
2931

30-
#### Game Updates
32+
- TODO
3133

32-
#### Learning Material Updates
34+
### Learning Material Updates
3335

34-
#### Engine Updates
36+
- TODO
3537

36-
#### Tooling Updates
38+
### Engine Updates
3739

38-
#### Library Updates
40+
- TODO
3941

40-
#### Other News
42+
### Tooling Updates
4143

42-
* [ ] Bullet points of any interesting news that doesn't have its own section - by @ozkrif
44+
- TODO
4345

44-
#### Discussions
46+
### Library Updates
4547

46-
## Publishing Steps
48+
- TODO
4749

48-
* [ ] Final review - by everyone
50+
### Other News
4951

50-
* [ ] Publish - by @ozkriff
52+
- TODO
5153

52-
* [ ] Post on /r/rust, /r/rust_gamedev, /r/gamedev, URLO, twitter.com/rust_gamedev - by @ozkriff
54+
### Discussions
5355

54-
* [ ] Pin thread on Twitter - by @ozkriff
56+
- TODO
5557

56-
* [ ] Add comment links - by @ozkriff
58+
## Publishing Steps
5759

58-
* [ ] Add a draft of next month's newsletter - by @ozkriff
60+
- [ ] Final review - by everyone
61+
- [ ] Publish - by @janhohenheim
62+
- [ ] Post on /r/rust, /r/rust_gamedev, /r/gamedev, URLO - by @janhohenheim
63+
- [ ] Pin thread on Twitter - by @AngelOnFira
64+
- [ ] Add comment links - by @AngelOnFira
5965

6066
## How to Contribute
6167

6268
If you want to help writing the newsletter:
6369

64-
* **Read [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z).**
65-
66-
* Choose one or more of the "🆓 **free**" sections listed below, and leave a comment letting us know you want to work on them.
67-
68-
* The links in brackets (like "[1](#), [2](#), [3](#)") are suggestions of links to include in the section. Feel free to add more!
69-
* The username listed next to the section (like "@ozkriff?") 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).
70-
* 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.
71-
* Extra sections not listed in the plan are welcomed - just leave a comment and open a PR!
72-
73-
* Write a short overview in the newsletter's Markdown file, making sure to follow the style guidelines (see below).
74-
75-
* Send a PR _to the `source` branch_ (example: [N15: A/B Street #336](https://github.com/rust-gamedev/rust-gamedev.github.io/pull/336)).
76-
77-
* Mention this issue in your PR's description to link it all together.
70+
- **Read [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z).**
71+
- Choose one or more of the "🆓 **free**" sections listed below, and leave a
72+
comment letting us know you want to work on them.
73+
- The links in brackets (like `[1](#), [2](#), [3](#)`) are suggestions of
74+
links to include in the section. Feel free to add more!
75+
- The username listed next to the section (like `@janhohenheim?`) is a
76+
suggestion of who may want to pick up the work (usually the project's
77+
developer, or someone who has expressed interest in the past).
78+
- You are not obligated to write a section if you're tagged or your project
79+
is listed! You're welcome to ask someone else to write the section,
80+
or to ask for your project to be excluded from this month's post.
81+
- Extra sections not listed in the plan are welcomed -
82+
just leave a comment and open a PR!
83+
- Write a short overview in the newsletter's Markdown file,
84+
making sure to follow the style guidelines (see below).
85+
- Send a PR _to the `source` branch_ (example: [N15: A/B Street #336](https://github.com/rust-gamedev/rust-gamedev.github.io/pull/336)).
86+
- Mention this issue in your PR's description to link it all together.
7887

7988
## Style Guidelines
8089

81-
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), but here are the most important rules:
90+
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),
91+
but here are the most important rules:
8292

83-
* Write in third-person perspective.
84-
85-
* Each line must be 80 characters or less, for ease of reviewing/diffing.
86-
87-
* Only one image per section is allowed.
88-
89-
* The maximum size is 300kb for static images and 2.5mb for GIFs.
90-
* The image should come before the text, and must have alt text for accessibility.
91-
* Prefer static images to GIFs, to keep the page load times down.
92-
93-
* Each section should be under 1000 characters, and under 6 paragraphs.
94-
95-
* This only applies to the rendered text, not the markup.
96-
97-
* Keep formatting minimal - no bold/italics/etc.
98-
99-
* Avoid long/nested bullet point lists - no changelogs!
93+
- Write in third-person perspective.
94+
- Each line must be 80 characters or less, for ease of reviewing/diffing.
95+
- Only one image per section is allowed.
96+
- The maximum size is 300kb for static images and 2.5mb for GIFs.
97+
- The image should come before the text, and must have alt text for accessibility.
98+
- Prefer static images to GIFs, to keep the page load times down.
99+
- Each section should be under 1000 characters, and under 6 paragraphs.
100+
- This only applies to the rendered text, not the markup.
101+
- Keep formatting minimal - no bold/italics/etc.
102+
- Avoid long/nested bullet point lists - no changelogs!
100103

101104
Please use these templates as a starting point:
102105

103106
**Games/apps/libraries:**
104107

105-
```
108+
```md
106109
### [Game name]
107110

108111
![alt text](img)
@@ -120,7 +123,7 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
120123

121124
**Articles/blog posts/videos/etc:**
122125

123-
```
126+
```md
124127
### [Article name]
125128

126129
![alt text](img)

0 commit comments

Comments
 (0)