Skip to content

Commit 9d86aed

Browse files
committed
Create CONTRIBUTING.md
1 parent 7fffab1 commit 9d86aed

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to visualCaseGen
2+
3+
Thank you for your interest in contributing to visualCaseGen!
4+
5+
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:
6+
7+
## Getting Started
8+
9+
Fork the repository and clone your fork.
10+
11+
Follow the instructions in the visualCaseGen documentation to set up your local visualCaseGen environment: https://esmci.github.io/visualCaseGen/
12+
13+
Create a new branch for your feature or bugfix.
14+
15+
## What You Can Contribute
16+
17+
- Bug fixes and issue resolutions
18+
- Enhancements to the GUI or core functionality
19+
- Improved documentation or examples
20+
- Code cleanup and test coverage
21+
22+
## Guidelines
23+
24+
- Follow the existing code style and structure.
25+
- Include clear commit messages.
26+
- Test your changes before submitting.
27+
- Add tests if you introduce new features.
28+
- Open a Pull Request with a short summary of your changes.
29+
- If addressing an open issue, mention it in your PR (e.g., Closes #42).
30+
31+
## Reporting Issues
32+
33+
Please use the GitHub Issues page to report bugs or suggest features. When reporting:
34+
35+
- Include the version of visualCaseGen you used and details about your system environment.
36+
- Provide clear steps to reproduce the issue.
37+
- Include screenshots or logs if helpful.

0 commit comments

Comments
 (0)