Skip to content

Improve contributing docs, README links #42

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

Merged
brews merged 3 commits into from
May 27, 2026
Merged

Improve contributing docs, README links #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f027c5
Add links to discussion, issues, contributing docs in README
brews May 27, 2026
bb58f41
Improve contributing docs. Add just cmd for prek hook setup.
brews May 27, 2026
2a2b8bf
Add CHANGELOG entry
brews May 27, 2026
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Minor improvements to README, CONTRIBUTING docs, developer experience. ([@brews](https://github.com/brews), [PR#42](https://github.com/ClimateImpactLab/isku/pull/42))


## [0.3.0] - 2026-05-15

Expand Down
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Anything tagged with "bug" and "help wanted" is open to whoever wants to impleme
Look through the GitHub issues for features.
Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

We strongly encourage contributers to discuss new features and changes before submitting PRs.

### Write Documentation

isku could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
Expand Down Expand Up @@ -55,7 +57,7 @@ Please note this documentation assumes you already have `uv`, `just`, and `git`

```bash
cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/isku.git
git clone git@github.com:YOUR_GH_NAME/isku.git
```

3. Now we need to install the environment. Navigate into the directory
Expand All @@ -73,7 +75,7 @@ uv sync
4. Install prek to run linters/formatters at commit time:

```bash
uv run prek install --prepare-hooks
just prepare-hooks
```

5. Create a branch for local development:
Expand Down Expand Up @@ -133,7 +135,7 @@ and then view your changes in a web browser by following the on-screen URL.

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
1. The pull request should include tests. Please write new tests to cover new behavior and features while ensuring older tests continue to pass.

2. If the pull request adds functionality, the docs should be updated.
Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.
Put your new functionality into a function with a docstring.
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,10 @@ Yes.

`isku` is open-source software made available under the terms of either the MIT License or the Apache License 2.0, at your option.

See CONTRIBUTING.md if you would like to contribute.
Ask questions about usage or general discussion on the project's [discussion page](https://github.com/ClimateImpactLab/isku/discussions).

Changes for each release are summarized in CHANGELOG.md.
Please file issues and bugs in the project's [issue tracker](https://github.com/ClimateImpactLab/isku/issues).

Please see the [contributing guide](https://github.com/ClimateImpactLab/isku/blob/main/CONTRIBUTING.md) if you would like to contribute.

Changes for each release are summarized in [the changelog](https://github.com/ClimateImpactLab/isku/blob/main/CHANGELOG.md).
4 changes: 4 additions & 0 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ build-docs:
# Start local web server to serve docs site
serve-docs:
uv run zensical serve

# Setup prek pre-commit hooks
prepare-hooks:
uv run prek install --prepare-hooks