generated from Leafwing-Studios/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b297511
Showing
36 changed files
with
1,184 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[target.x86_64-pc-windows-msvc] | ||
linker = "rust-lld.exe" | ||
rustflags = ["-Zshare-generics=off"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
*.png filter=lfs diff=lfs merge=lfs -text | ||
*.svg filter=lfs diff=lfs merge=lfs -text | ||
*.jpg filter=lfs diff=lfs merge=lfs -text | ||
*.gif filter=lfs diff=lfs merge=lfs -text | ||
*.mpeg filter=lfs diff=lfs merge=lfs -text | ||
*.zip filter=lfs diff=lfs merge=lfs -text | ||
*.7z filter=lfs diff=lfs merge=lfs -text | ||
*.avi filter=lfs diff=lfs merge=lfs -text | ||
*.bmp filter=lfs diff=lfs merge=lfs -text | ||
*.mp3 filter=lfs diff=lfs merge=lfs -text | ||
*.wav filter=lfs diff=lfs merge=lfs -text | ||
*.png filter=lfs diff=lfs merge=lfs -text | ||
*.tar filter=lfs diff=lfs merge=lfs -text | ||
*.gltf filter=lfs diff=lfs merge=lfs -text | ||
*.ttf filter=lfs diff=lfs merge=lfs -text | ||
*.otf filter=lfs diff=lfs merge=lfs -text | ||
*.ods filter=lfs diff=lfs merge=lfs -text | ||
*.ogg filter=lfs diff=lfs merge=lfs -text | ||
*.psd filter=lfs diff=lfs merge=lfs -text | ||
*.max filter=lfs diff=lfs merge=lfs -text | ||
*.blend filter=lfs diff=lfs merge=lfs -text | ||
*.fbx filter=lfs diff=lfs merge=lfs -text | ||
*.dae filter=lfs diff=lfs merge=lfs -text | ||
*.obj filter=lfs diff=lfs merge=lfs -text |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Bug Report | ||
about: Report a bug to help us improve! | ||
title: '' | ||
labels: "T: bug", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## Version | ||
|
||
The release number or commit hash of the version you're using. | ||
|
||
## Operating system & version | ||
|
||
Ex: Windows 10, Ubuntu 18.04, iOS 14. | ||
|
||
## What you did | ||
|
||
The steps you took to uncover this bug. | ||
Please list full reproduction steps if feasible. | ||
|
||
## What you expected to happen | ||
|
||
What you think should've happened if everything was working properly. | ||
|
||
## What actually happened | ||
|
||
The actual result of the actions you described. | ||
|
||
## Additional information | ||
|
||
Any additional information you would like to add such as screenshots, logs, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Code Quality | ||
about: Help us reduce tech debt and write better code! | ||
title: '' | ||
labels: "T: code-quality", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## Which code could be improved? | ||
|
||
Provide a direct link to the source if possible. | ||
|
||
Mention other related code if relevant. | ||
|
||
## How should this be changed? | ||
|
||
If it's not obvious, include a snippet and explain why this change is better. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Docs Improvement | ||
about: Help us write better docs to catch common issues! | ||
title: '' | ||
labels: "T: documentation", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## What problem did the developer encounter? | ||
|
||
Briefly describe the problem the developer encountered. Links are welcome. | ||
|
||
## What was the fix? | ||
|
||
Describe the solution that was suggested to fix their problem or the explanation that was given. | ||
|
||
## How could this be better documented? | ||
|
||
Point to docs that were incomplete or misleading. | ||
If you have suggestions on exactly what the new docs should say, feel free to include it here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Feature request | ||
about: Propose a new feature! | ||
title: '' | ||
labels: "T: enhancement", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## What problem does this solve? | ||
|
||
What do you want to do? | ||
|
||
## What solution would you like? | ||
|
||
Lay out what an ideal solution would look like, from a user-facing perspective. | ||
|
||
## [Optional] How could this be implemented? | ||
|
||
Briefly sketch out how this could be put in place. | ||
|
||
## [Optional] What alternatives have you considered? | ||
|
||
Mention other possible solutions to solve the problem presented. If you have strong opinions, explain why they wouldn't be good enough. | ||
|
||
If workarounds exist, briefly describe them and explain why they're inadequate. | ||
|
||
## Related work | ||
|
||
Explain how any other related features or bugs tie into this feature request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Performance | ||
about: Help us make things go fast! | ||
title: '' | ||
labels: "T: performance", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## What were you trying to do? | ||
|
||
Describe what you were trying to accomplish. | ||
|
||
If possible, provide a link to a runnable reproduction. | ||
|
||
## How did you know this was slow? | ||
|
||
Briefly describe symptoms of performance issues. | ||
|
||
If available, attach or link to logs, diagnostics or benchmarks. | ||
|
||
## [Optional] Why is this slow? | ||
|
||
If you have hunches (or proof!) about what's making this slow, discuss it here. | ||
|
||
Provide direct links to the code in question where possible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Prototype Required | ||
about: Propose a prototype or playtest to test hypotheses | ||
title: '' | ||
labels: design | ||
assignees: '' | ||
--- | ||
|
||
## What questions need to be answered? | ||
|
||
Explain the uncertainties that exist. | ||
|
||
Use a numbered list so discussion can refer back to these questions. | ||
|
||
## What do you expect the answers will be? | ||
|
||
If you have any hypotheses, explain what you think they'll be and why. | ||
|
||
## What is the minimal viable test for this? | ||
|
||
Describe the simplest test that would be able to answer these questions. | ||
|
||
Remember to consider the following cheaper prototyping tools: | ||
|
||
- static analysis | ||
- abstract simulations | ||
- API mock-ups | ||
- pen-and-paper playtesting | ||
|
||
## Why do we need to know this now? | ||
|
||
What other features or designs are blocked by this answer? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
name: Usability Friction | ||
about: Help us polish the user experience! | ||
title: '' | ||
labels: "T: usability", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## Which feature is frustrating to use or confusing? | ||
|
||
The rule, interaction or feature that creates friction. | ||
|
||
## Expectation | ||
|
||
How do you intuitively expect this to behave? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Content Creation | ||
about: Add your sweet content to the game! | ||
title: '' | ||
labels: content-idea | ||
assignees: '' | ||
--- | ||
|
||
## Which type of content is this? | ||
|
||
Pick one of: | ||
|
||
- TEMPLATE_OPTION | ||
- TEMPLATE_OPTION | ||
|
||
## What niche does this fill? | ||
|
||
Describe the emotional fantasy that this content captures. | ||
References to other media can be useful, but you need to avoid direct copying. | ||
|
||
If needed, explain why it's poorly satisfied by other existing similar pieces of content. | ||
|
||
## Outstanding issues | ||
|
||
What parts of the design, if any, are you unsatisfied with? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Design Change | ||
about: Improve a bit of the game's design | ||
title: '' | ||
labels: design | ||
assignees: '' | ||
--- | ||
|
||
## What problem does the current design create? | ||
|
||
Explain why the design results in undesirable outcomes. | ||
|
||
## How does the proposed fix improve on this? | ||
|
||
Tie the changes to the problem. | ||
|
||
## What compromises had to be made? | ||
|
||
Discuss sacrifices made, if any, so they can be improved upon by reviewers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Pull request | ||
about: Fix a bug, add a feature, improve some docs | ||
title: '' | ||
labels: "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
## What was the problem? | ||
|
||
Mention any issues that this closes with "Closes #X" here. | ||
|
||
## How did you fix it? | ||
|
||
Briefly describe the steps you took to make this repository better. | ||
|
||
## \[Optional\] What needs special attention? | ||
|
||
If there are any particularly tricky areas of the PR that deserve extra attention, call them out here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Request for Comments | ||
about: Create a central point for discussion of particularly complex concepts | ||
title: '' | ||
labels: "I: rfc", "S: needs-triage" | ||
assignees: '' | ||
--- | ||
|
||
RFCs are used to collaboratively refine particularly complex designs in a scalable fashion before work begins. | ||
|
||
For *Leafwing Studios,* the RFC process is pretty straightforward: | ||
|
||
1. Copy the `docs/src/rfc/archived/000-rfc-template.md` file into a new file in the `active` subfolder. | ||
2. Choose a descriptive feature name and the next available RFC number, and update the template and file name. | ||
3. Reference any related issues / work in this PR's thread to ensure proper linking. | ||
4. Refine the RFC until the team is ready to begin implementation. | ||
5. To reduce overhead, follow-up work should be done as part of the same PR if possible. | ||
6. Once the RFC is complete, move it from active to archived. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"MD013": false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "^https?://github\\.com/" | ||
} | ||
], | ||
"replacementPatterns": [], | ||
"httpHeaders": [ | ||
{ | ||
"urls": [ | ||
"https://crates.io" | ||
], | ||
"headers": { | ||
"Accept": "text/html" | ||
} | ||
} | ||
], | ||
"timeout": "20s", | ||
"retryOn429": true, | ||
"retryCount": 5, | ||
"fallbackRetryDelay": "30s", | ||
"aliveStatusCodes": [ | ||
200, | ||
206 | ||
] | ||
} |
Oops, something went wrong.