Skip to content

Commit 7b24753

Browse files
mpuszmpusz
committed
chore: add usage experience issue template and a chapter in README
1 parent b5d8045 commit 7b24753

File tree

2 files changed

+202
-0
lines changed

2 files changed

+202
-0
lines changed

‎.github/ISSUE_TEMPLATE/usage_experience.yml‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
name: 🌟 Share Your mp-units Usage Experience
2+
description: Help us showcase real-world usage for C++ standardization efforts
3+
title: "[Usage]: "
4+
labels: ["usage experience"]
5+
assignees: ["mpusz"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## 🚀 Help Shape the Future of C++!
11+
12+
Your experience with **mp-units** is valuable for our C++29 standardization efforts!
13+
14+
Whether you're using mp-units in production, research, or personal projects, we'd love to hear about:
15+
- Your use case and domain
16+
- Benefits you've experienced
17+
- Any challenges or limitations
18+
- Impact on your development process
19+
20+
**This information will help demonstrate real-world value to the C++ standards committee.** ⚖️
21+
22+
- type: dropdown
23+
id: organization_type
24+
attributes:
25+
label: Organization Type
26+
description: What type of organization are you representing?
27+
options:
28+
- Individual Developer
29+
- Startup (< 50 employees)
30+
- Small Company (50-200 employees)
31+
- Medium Company (200-1000 employees)
32+
- Large Enterprise (1000+ employees)
33+
- Academic Institution
34+
- Research Organization
35+
- Government/Public Sector
36+
- Open Source Project
37+
- Other
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: organization_name
43+
attributes:
44+
label: Organization Name (Optional)
45+
description: Name of your company, institution, or project (leave blank if you prefer to remain anonymous)
46+
placeholder: "e.g., Acme Corp, University of Technology, MyOpenSourceProject"
47+
48+
- type: dropdown
49+
id: usage_domain
50+
attributes:
51+
label: Primary Domain/Industry
52+
description: What domain do you primarily use mp-units in?
53+
options:
54+
- Aerospace/Aviation
55+
- Automotive
56+
- Robotics
57+
- Scientific Computing
58+
- Engineering Simulation
59+
- Financial Modeling
60+
- Game Development
61+
- IoT/Embedded Systems
62+
- Research & Development
63+
- Education/Teaching
64+
- Physics/Chemistry
65+
- Manufacturing
66+
- Energy/Power Systems
67+
- Medical/Healthcare
68+
- Other
69+
validations:
70+
required: true
71+
72+
- type: input
73+
id: other_domain
74+
attributes:
75+
label: Other Domain (if selected above)
76+
description: Please specify your domain if you selected "Other"
77+
78+
- type: dropdown
79+
id: project_stage
80+
attributes:
81+
label: Project Stage
82+
description: What stage is your mp-units usage in?
83+
options:
84+
- Evaluation/Prototyping
85+
- Development
86+
- Testing/Validation
87+
- Production/Deployed
88+
- Research/Academic
89+
- Educational Use
90+
validations:
91+
required: true
92+
93+
- type: dropdown
94+
id: team_size
95+
attributes:
96+
label: Development Team Size
97+
description: How many developers work on projects using mp-units?
98+
options:
99+
- Just me (1)
100+
- Small team (2-5)
101+
- Medium team (6-15)
102+
- Large team (16+)
103+
- Multiple teams
104+
validations:
105+
required: true
106+
107+
- type: textarea
108+
id: use_case
109+
attributes:
110+
label: Use Case Description
111+
description: Briefly describe how you use mp-units in your project(s)
112+
placeholder: |
113+
Example: "We use mp-units in our satellite orbit simulation software to ensure dimensional consistency across physics calculations. It handles units for position (km), velocity (km/s), and time (s) with compile-time validation."
114+
validations:
115+
required: true
116+
117+
- type: checkboxes
118+
id: features_used
119+
attributes:
120+
label: Features Used
121+
description: Which mp-units features do you primarily use? (Select all that apply)
122+
options:
123+
- label: Basic quantity arithmetic (addition, subtraction, multiplication, division)
124+
- label: Unit conversions (m to km, s to h, etc.)
125+
- label: Dimensional analysis and compile-time validation
126+
- label: Custom units and dimensions
127+
- label: Quantity points
128+
- label: Text formatting and I/O
129+
- label: C++ modules support
130+
- label: Interoperability with other libraries
131+
- label: SI unit system
132+
- label: Other unit systems (CGS, Imperial, etc.)
133+
- label: Natural units
134+
- label: Freestanding mode
135+
136+
- type: textarea
137+
id: benefits
138+
attributes:
139+
label: Key Benefits Experienced
140+
description: What benefits have you seen from using mp-units?
141+
placeholder: |
142+
Example benefits:
143+
- Eliminated unit conversion errors
144+
- Improved code readability and documentation
145+
- Caught dimensional analysis bugs at compile time
146+
- Simplified physics calculations
147+
- Better API design with type safety
148+
validations:
149+
required: true
150+
151+
- type: dropdown
152+
id: impact_level
153+
attributes:
154+
label: Impact on Your Project
155+
description: How significant has mp-units been for your project?
156+
options:
157+
- Game-changing - Solved major problems
158+
- Very helpful - Significant improvements
159+
- Moderately useful - Some benefits
160+
- Minor impact - Small improvements
161+
- Still evaluating
162+
validations:
163+
required: true
164+
165+
- type: checkboxes
166+
id: usage_permissions
167+
attributes:
168+
label: Usage Permissions
169+
description: How can we use this information?
170+
options:
171+
- label: ✅ You can mention our organization name publicly
172+
- label: ✅ You can use our testimonial in documentation and presentations
173+
174+
- type: markdown
175+
attributes:
176+
value: |
177+
---
178+
179+
## 🙏 Thank You!
180+
181+
Your contribution helps demonstrate the real-world value of dimensional analysis in C++ and supports our standardization efforts.
182+
183+
**What happens next?**
184+
- We'll review your submission and may reach out for clarification
185+
- Your experience may be featured in our documentation (with permission)
186+
- Aggregate usage data helps our WG21 standardization efforts
187+
- You're contributing to the future of safe, expressive C++!

‎README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ More context can be found in the following ISO C++ proposals:
3030
> 🤝 **We are actively seeking organizations and individuals interested in**
3131
> **field‑trialing the library!**
3232
33+
34+
## 🌟 Share Your Success Story
35+
36+
**Help shape the future of C++!**
37+
Your testimonials help **demonstrate real-world value** to the ISO C++ Committee!
38+
39+
Whether you're using mp-units in **production**, **research**, or **education**:
40+
41+
- 🏢 **Organizations**: Share your production deployments and success stories
42+
- 🎓 **Academics**: Report research applications and teaching experiences
43+
- 🧑‍💻 **Developers**: Tell us about your innovative use cases and benefits
44+
45+
[![Share Experience](https://img.shields.io/badge/Share_Your-Usage_Experience-blue?style=for-the-badge&labelColor=black)](https://github.com/mpusz/mp-units/issues/new?template=usage_experience.yml)
46+
47+
3348
## 📚 Documentation
3449

3550
Extensive project documentation is available on the **[project site](https://mpusz.github.io/mp-units)**.

0 commit comments

Comments
 (0)