Contribution Workflow

Contribution Workflow

All contributions to the MieSimulatorGUI must follow the workflow outlined below to ensure changes are traceable, reviewable, and consistent.

1. Create an Issue First

Before starting any work:

• Create a GitHub issue describing the bug, enhancement, or feature request.
• Clearly explain the motivation, scope, and expected behavior.
• Wait for confirmation or discussion if the change is significant.
• Every code change must be associated with an issue.

2. Fork the Repository

• Fork the main repository into your own GitHub account.
• All development work must be done in your fork, not directly in the main repository.

3. Create a Feature Branch

Create a new branch from the default branch (e.g., master). The branch name must be derived from the issue and prepended with feature/.

Branch naming format: feature/<issue-number>-short-description

Example: feature/42-add-particle-size-slider

4. Implement the Change

• Follow all coding conventions defined in this document.
• Keep changes focused on the scope of the issue.
• Ensure the code builds and tests pass before submitting.

5. Open a Pull Request

Open a Pull Request (PR) from your feature branch to the main repository. Reference the related issue in the PR description (e.g., Closes #42).

Clearly describe:

• What was changed
• Why the change was made
• Any relevant design or implementation details

6. Code Review and Approval

• All pull requests require review before merging.
• Be prepared to address feedback or requested changes.
• Once approved, the pull request will be merged by a repository maintainer.

Important

Direct commits to the main repository are not permitted.