Improve documentation

.gitattributes

@@ -0,0 +1,14 @@
+# From: https://docs.github.com/en/github/getting-started-with-github/configuring-git-to-handle-line-endings
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+.gitattributes text eol=lf
+.gitignore text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.rs text eol=lf
+*.sh text eol=lf
+*.toml text eol=lf
+*.yml text eol=lf

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://bevyengine.org/donate/

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,54 @@
+---
+name: Bug Report
+about: Report a bug to help us improve!
+title: ''
+labels: C-Bug, S-Needs-Triage
+assignees: ''
+---
+
+## `variadics_please` version
+
+The release number or commit hash of the version you're using.
+
+## Relevant system information
+
+This section is optional. Remove it if you know that the problem is not platform dependent.
+
+Rust version you're using: (`cargo --version`)
+
+```text
+
+```
+
+> Notes:
+>
+> - Pay attention to the msrv (minimum supported rust version) of `variadics_please`.
+> - `nightly` should work, but sometimes there are regressions: please let us know!
+
+Operating system, including version:
+
+```text
+
+```
+
+## What you did
+
+Describe how you arrived at the problem. If you can, consider providing a code snippet or link.
+
+## What went wrong
+
+If it's not clear, break this out into:
+
+- what were you expecting?
+- what actually happened?
+
+## Additional information
+
+Other information that can be used to further reproduce or isolate the problem.
+This commonly includes:
+
+- screenshots
+- logs
+- theories about what might be going wrong
+- workarounds that you used
+- links to related bugs, PRs or discussions

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+contact_links:
+  - name: Question
+    url: https://github.com/bevyengine/variadics_please/discussions
+    about: Questions about how to use or contribute belong in Github Discussions.
+      You can use the search to check if someone already answered your question!
+
+  - name: Community
+    url: https://discord.gg/bevy
+    about: If you'd like to converse with members of the `bevyengine` community, join us on discord. There is a channel for development of this crate.

.github/ISSUE_TEMPLATE/docs_improvement.md

@@ -0,0 +1,13 @@
+---
+name: Documentation Improvement
+about: Help us write better documentation!
+title: ''
+labels: C-Documentation, S-Needs-Triage
+assignees: ''
+---
+
+## How can the documentation be improved?
+
+Provide a link to the documentation and describe how it could be improved. In what ways is it incomplete, incorrect, or misleading?
+
+If you have suggestions on exactly what the new docs should say, feel free to include them here. Alternatively, make the changes yourself and create a pull request instead.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Propose a new feature!
+title: ''
+labels: C-Feature, S-Needs-Triage
+assignees: ''
+---
+
+## What problem does this solve or what need does it fill?
+
+A description of why this particular feature should be added.
+
+## What solution would you like?
+
+The solution you propose for the problem presented.
+
+## What alternative(s) have you considered?
+
+Other solutions to solve and/or work around the problem presented.
+
+## Additional context
+
+Any other information you would like to add such as related previous work,
+screenshots, benchmarks, etc.

.github/ISSUE_TEMPLATE/performance_regression.md

@@ -0,0 +1,67 @@
+---
+name: Performance Regression
+about: Running slowly after upgrading? Report a performance regression.
+title: ''
+labels: C-Bug, C-Performance, P-Regression, S-Needs-Triage
+assignees: ''
+---
+
+## `variadics_please` version
+
+Original: `` <!-- The release number or commit hash of the version you last tested your app against. -->
+
+Current: `` <!-- The release number or commit hash of the version you're currently using. -->
+
+## Relevant system information
+
+This section is optional. Remove it if you know that the problem is not platform dependent.
+
+Rust version you're using: (`cargo --version`)
+
+```text
+
+```
+
+> Notes:
+>
+> - Pay attention to the msrv (minimum supported rust version) of `variadics_please`.
+> - `nightly` should work, but sometimes there are regressions: please let us know!
+
+Operating system, including version:
+
+```text
+
+```
+
+## What's performing poorly?
+
+Describe how you arrived at the problem. If you can, consider providing a code snippet or link
+to help reproduce the regression.
+
+If the exact scenario is not immediately reproducible on `cargo run`, please include a set list of steps to produce the correct setup.
+
+## Before and After Traces
+
+To best help us investigate the regression, it's best to provide as much detailed profiling
+data as possible.
+
+If your app is running slowly, please show profiler traces before and after the change.
+For more information on how to get these traces, see
+<https://github.com/bevyengine/variadics_please/blob/main/documentation/profiling.md>.
+
+If this is about a compile-time regression, please provide the full output of `cargo build --timings`,
+for more information see <https://doc.rust-lang.org/cargo/reference/timings.html>.
+
+- Before:
+- After:
+
+## Additional information
+
+Other information that can be used to further reproduce or isolate the problem.
+This commonly includes:
+
+- screenshots
+- logs
+- theories about what might be going wrong
+- workarounds that you used
+- links to related bugs, PRs or discussions

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: cargo
+    directory: /
+    schedule:
+      interval: weekly
+    labels:
+      - "C-Dependencies"
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    labels:
+      - "C-Dependencies"

.github/example-run/all_tuples.ron

@@ -0,0 +1,2 @@
+(
+)

.github/linters/.markdown-lint.yml

@@ -0,0 +1,9 @@
+{
+    "MD013": false,
+    "no-inline-html": {
+        "allowed_elements": [
+            "details",
+            "summary"
+        ]
+    }
+}

.github/pull_request_template.md

@@ -0,0 +1,42 @@
+# Objective
+
+Describe the objective or issue this PR addresses.
+
+If you're fixing a specific issue, simply say "Fixes #X".
+
+## Solution
+
+Describe the solution used to achieve the objective above.
+
+## Testing
+
+- Did you test these changes? If so, how?
+- Are there any parts that need more testing?
+- How can other people (reviewers) test your changes? Is there anything specific they need to know?
+- If relevant, what platforms did you test these changes on, and are there any important ones you can't test?
+
+## Showcase
+
+This section is optional. If this PR does not include a visual change or does not add a new feature, you can delete this section.
+
+- Help others understand the result of this PR by showcasing your awesome work!
+- If this PR adds a new feature or public API, consider adding a brief pseudo-code snippet of it in action
+- If this PR includes a visual change, consider adding a screenshot, GIF, or video
+  - If you want, you could even include a before/after comparison!
+- If the Migration Guide adequately covers the changes, you can delete this section
+
+While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases:
+
+```rust
+println!("My super cool code.");
+```
+
+</details>
+
+## Migration Guide
+
+> This section is optional. If there are no breaking changes, you can delete this section.
+
+- If this PR is a breaking change (relative to the last release), describe how a user might need to migrate their code to support these changes
+- Simply adding new functionality is not a breaking change.
+- Fixing behavior that was definitely a bug, rather than a questionable design choice is not a breaking change.

.github/workflows/action-on-PR-labeled.yml

@@ -0,0 +1,30 @@
+name: Action on PR labeled
+
+# This workflow has write permissions on the repo
+# It must not checkout a PR and run untrusted code
+
+on:
+  pull_request_target:
+    types:
+      - labeled
+
+permissions:
+  pull-requests: 'write'
+
+jobs:
+  comment-on-breaking-change-label:
+    runs-on: ubuntu-latest
+    if: github.event.label.name == 'M-Needs-Migration-Guide' && !contains(github.event.pull_request.body, '## Migration Guide')
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `It looks like your PR is a breaking change, but you didn't provide a migration guide.
+
+              Could you add some context on what users should update when this change get released?
+              Putting it after a \`## Migration Guide\` will help it get automatically picked up by our tooling.`
+            })