File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to Cheese3D
2+
3+ Thanks for your interest in contributing!
4+
5+ ## Getting started
6+
7+ 1 . Fork and clone the repository.
8+ 2 . Install [ Pixi] ( https://pixi.sh ) , then set up the environment:
9+ ``` bash
10+ pixi install
11+ ```
12+ 3 . Create a branch for your changes:
13+ ``` bash
14+ git checkout -b my-change
15+ ```
16+
17+ ## Making changes
18+
19+ - If you change behavior or add a feature, update the docs under ` docs/source/ ` .
20+ - Write a clear commit message describing the * why* of your change.
21+
22+ ## Building the docs
23+
24+ ``` bash
25+ pixi run docs # build once
26+ pixi run docs-serve # build and serve with live reload
27+ ```
28+
29+ ## Submitting a pull request
30+
31+ 1 . Push your branch to your fork.
32+ 2 . Open a pull request against ` main ` .
33+ 3 . Describe what changed and why, and link any related issues.
34+
35+ ## Reporting bugs
36+
37+ Open an issue on GitHub and include:
38+
39+ - A short description of the problem
40+ - Steps to reproduce
41+ - Expected vs. actual behavior
42+ - Your OS, Python version, and Cheese3D version
Load Diff This file was deleted.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments