Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.27 KB

Contributing to visualCaseGen

Thank you for your interest in contributing to visualCaseGen!

We welcome contributions that fix bugs, introduce new features, and enhance the usability, robustness, or performance of the tool. Here's how you can get involved:

Getting Started

Fork the repository and clone your fork.

Follow the instructions in the visualCaseGen documentation to set up your local visualCaseGen environment: https://esmci.github.io/visualCaseGen/

Create a new branch for your feature or bugfix.

What You Can Contribute

  • Bug fixes and issue resolutions
  • Enhancements to the GUI or core functionality
  • Improved documentation or examples
  • Code cleanup and test coverage

Guidelines

  • Follow the existing code style and structure.
  • Include clear commit messages.
  • Test your changes before submitting.
  • Add tests if you introduce new features.
  • Open a Pull Request with a short summary of your changes.
  • If addressing an open issue, mention it in your PR (e.g., Closes #42).

Reporting Issues

Please use the GitHub Issues page to report bugs or suggest features. When reporting:

  • Include the version of visualCaseGen you used and details about your system environment.
  • Provide clear steps to reproduce the issue.
  • Include screenshots or logs if helpful.