Skip to content
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

docs: CONTRIBUTING.md #547

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: CONTRIBUTING.md #547

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5eed071
add CONTRIBUTING.md
pfackeldey Oct 7, 2024
090db33
Merge branch 'main' into add/CONTRIBUTING.md
pfackeldey Oct 7, 2024
ec12efe
update README.md with contributing link
pfackeldey Oct 9, 2024
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,5 @@ venv.bak/

# mypy
.mypy_cache/

pyrightconfig.json
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to dask-awkward

Install the development environment (once) with

```bash
uv venv
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

python -m venv

rather than assume users have uv (or conda or whatever)

uv pip install -e '.[io,docs,test]'
pre-commit install
```

Source development environment with

```bash
source .venv/bin/activate
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this need to come before pip install?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general yes, but not with uv. If it finds a venv (even though it is not activated) it will install software into it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, so if we remove requiring uv, then this will need to be reordered. That's conceptually cleaner anyway, if you ask me.

```

Run tests with

```bash
pytest .
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pytest .
pytest -v

```

Build documentation with

```bash
cd docs && make html
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does && work on windows?

Also worth saying where the docs end up.

```
Loading