# Contributing to WISER

Questions, bugs, and feature requests can be submitted as
[GitHub Issues](https://github.com/Ehlmann-research-group/WISER/issues),
or via the [WISER feedback form](https://forms.gle/eqkdnv9b2ogEUbPp6)
if you prefer not to use GitHub.

## Reporting a Bug

Thank you for helping make WISER better!
If you find a problem or unexpected behavior, you can report it in two ways:

- **[Submit via the feedback form](https://forms.gle/eqkdnv9b2ogEUbPp6)** — no GitHub account required.
- **[Submit a GitHub Issue](https://github.com/Ehlmann-research-group/WISER/issues/new/choose)** — use the **Bug report
  ** template.

When filling out the issue form:

- Clearly **describe the bug** --- what went wrong and where.
- Include **steps to reproduce** the problem (numbered if possible).
- State what you **expected to happen** versus what actually occurred.
- Add **screenshots or console messages** if they help explain the issue.
- Include details about your **system setup**:
    - Operating System (e.g., Windows, macOS, Linux)
    - CPU architecture (x86_64, ARM, etc.)
    - WISER version (e.g., `1.4b1`)

If there is an error message, paste it under **Error Message**, and add any
**additional context** that might help reproduce or understand the bug.

Once submitted, maintainers will review your report. They may ask for
clarification or logs to help pinpoint the issue. Please be patient and
responsive: this helps get your bug fixed faster!

## Requesting a Feature

Before submitting a feature request, please review the following guidelines.

Submit a new feature request using one of these options:

- **[Submit via the feedback form](https://forms.gle/eqkdnv9b2ogEUbPp6)** — no GitHub account required.
- **[Submit a GitHub Issue](https://github.com/Ehlmann-research-group/WISER/issues/new/choose)** — use the **Feature
  request** template.

When filling out the template:

- Clearly describe the **problem** your feature aims to solve.
- Propose a **solution** and explain how it fits with **WISER's mission**.
- Include any **alternatives** or design ideas you have considered.
- Add **context, screenshots, or examples** if applicable.

Feature requests should align with **WISER's mission**. Not all requests will
be accepted: some may require discussion and iteration to refine into a
concrete, well-scoped solution. Please be patient and open to feedback.

## Contributing Code

Want to contribute a fix or feature? Start here:

1. **Open an issue first** — describe what you want to change and why. This
   avoids duplicate work and lets maintainers give early feedback on the approach.
2. **Set up your environment** — see the [Developer Environment Setup](developer-content/environment-setup).
3. **Read the contribution standards** — branching strategy, code review
   expectations, commit message format, and style conventions are documented in
   [Contributing & Code Quality](developer-content/contributing-and-quality).
4. **Write tests** — new features and bug fixes should include tests. See the
   [Testing & QA](developer-content/testing-and-qa) guide.
5. **Open a pull request** — link it to your issue. The PR description is the
   merge commit body, so write it clearly.

