File tree Expand file tree Collapse file tree 1 file changed +31
-0
lines changed
Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ Thank you for your interest in contributing! This document provides guidelines for
4+ contributing to the project. If you have a problem to report or improvement to suggest
5+ please open an issue or open a pull request. To do so, please follow the instructions below.
6+
7+ ## Reporting Issues
8+
9+ - Use GitHub Issues for bug reports and feature requests
10+ - Include a minimal reproducible example for bugs
11+ - Specify Julia version and package environment details
12+
13+ ## Pull Requests
14+
15+ - Fork the repository and create a new branch for your changes
16+ - Write clear commit messages describing your changes
17+ - Ensure your code follows the project's coding style (see below)
18+ - Include tests for new features or bug fixes
19+ - Update documentation if necessary
20+
21+ ## Code Style
22+
23+ - Try to follow the [ Julia style guide] ( https://docs.julialang.org/en/v1/manual/style-guide/ )
24+ - Use meaningful variable and function names
25+ - Mathematical symbols and unicode characters as variable names are encouraged if they are
26+ properly introduced in the documentation
27+ - Add docstrings to public functions using the standard Julia format
28+
29+ ## Questions?
30+
31+ Feel free to open an issue or discussion if you have questions about contributing!
You can’t perform that action at this time.
0 commit comments