Skip to content

Commit 8cb06e8

Browse files
committed
Add minimal contributing.md file
1 parent 3babaa0 commit 8cb06e8

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to Dedalus
2+
3+
Thank you for your interest in contributing to Dedalus! We welcome contributions in the form of bug reports, feature requests, documentation improvements, and code contributions.
4+
5+
## Asking for Help
6+
- For help installing Dedalus or setting up a simulation, please use the [Google Group](https://groups.google.com/g/dedalus-users).
7+
- For help with source code modifications or additions, please use GitHub issues and pull requests.
8+
9+
## Reporting Issues
10+
- Please search existing issues to avoid duplicates.
11+
- Provide a clear, minimal working example if reporting a bug.
12+
- Use descriptive titles and labels when possible.
13+
14+
## Code Contributions
15+
- Please generally follow [PEP 8](https://peps.python.org/pep-0008/) for style.
16+
- Write docstrings in the [Numpy format](https://numpydoc.readthedocs.io/en/latest/format.html#parameters).
17+
- Try to make small commits with meaningful commit messages.
18+
- Ensure tests pass by running:
19+
```sh
20+
python3 -m dedalus test
21+
```
22+
- Open a pull request with a clear description of changes.
23+
- Feel free to open early/draft pull requests and ask for help!
24+
25+
## Documentation
26+
- Improve docs by editing `.rst` files in `docs/`.
27+
- Build docs locally with:
28+
```sh
29+
cd docs
30+
make html
31+
```
32+
33+
We appreciate your contributions!

0 commit comments

Comments
 (0)