Skip to content

Some words in the contribution guide #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+4,402 −13
Open

Some words in the contribution guide #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions docs/library/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

---

## Why Contribute

- Gain practical experience with Python, software development, and actuarial methods.
- Meet like-minded actuaries that prefer open-source software.
- Help advance open-source actuarial research and reproducible methodologies.
- Contributing is rewarding and fun!

---

## How to Contribute

You can help improve and shape the project in many ways:
Expand All @@ -12,7 +21,7 @@ You can help improve and shape the project in many ways:
2. Volunteer to implement code changes for existing issues.
3. Ask questions or discuss ideas on the [discussion forum](https://github.com/casact/chainladder-python/discussions).
4. Improve documentation where it is unclear.
5. Create new examples or tutorials in the [examples section](https://chainladder-python.readthedocs.io/en/latest/auto_examples/index.html).
5. Create new examples or tutorials in the [examples section](https://chainladder-python.readthedocs.io/en/latest/gallery/index.html).

---

Expand All @@ -26,14 +35,6 @@ If you're interested in joining, please contact one of the core developers. We w

---

## Why Contribute

- Gain practical experience with Python, software development, and actuarial methods.
- Help advance open-source actuarial research and reproducible methodologies.
- Contributing is rewarding—and fun!

---

## API Guidelines

`chainladder-python` is designed to follow the style of **pandas** and **scikit-learn**. This ensures a consistent API and simplifies new development:
Expand All @@ -48,21 +49,24 @@ For domain-specific exceptions, discuss on the [issue tracker](https://github.co

## Development Environment

After forking the repository, set up a development environment using `uv`:
After forking the repository, you can set up a development environment using `uv`:

```bash
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone your fork
git clone https://github.com/YOUR_USERNAME/chainladder-python.git
# Add uv to your PATH
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# Navigate to your working directory
cd chainladder-python

# Create virtual environment and install all dependencies
uv sync --extra all

# Activate the environment
source .venv/bin/activate # On Windows: .venv\Scripts\activate
uv run python
```

This will install the package in editable mode with all development dependencies. After finishing work, deactivate:
Expand Down
Loading