Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Rework README and move dev instructions to contributing #481

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
merged 12 commits into from
Nov 4, 2024
Merged

Rework README and move dev instructions to contributing #481

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7ad4f88
Tidy up README
samcunliffe Oct 29, 2024
4737b69
Tidy up dev instructions. Remove duplicated.
samcunliffe Oct 29, 2024
e123e18
Move suppression of MD033 into dotfile which I didn't notice.
samcunliffe Oct 29, 2024
2d5f0a7
@dstansby's language clarifications.
samcunliffe Nov 1, 2024
c1aab30
Merge branch 'main' into sc/rework-readme-and-move-dev-instructions-t…
samcunliffe Nov 1, 2024
d46b6f9
Merge branch 'main' into sc/rework-readme-and-move-dev-instructions-t…
paddyroddy Nov 1, 2024
3900cbc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 1, 2024
9213fed
Remove "pedagogical" and "geared towards" → "aimed at"
samcunliffe Nov 4, 2024
6816c2e
Don't give instructions on installing cookiecutter.
samcunliffe Nov 4, 2024
70fdc49
Remove hidden sections for DRY.
samcunliffe Nov 4, 2024
de3b099
Consistent link style.
samcunliffe Nov 4, 2024
c3dabc9
Add more comments to markdownlint.yaml.
samcunliffe Nov 4, 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
Prev Previous commit
Next Next commit
@dstansby's language clarifications. 
Co-authored-by: David Stansby <dstansby@gmail.com>
  • Loading branch information
@samcunliffe @dstansby
samcunliffe and dstansby authored Nov 1, 2024
commit 2d5f0a7d22bd89c23008849f79477db3aba2fdbf
2 changes: 1 addition & 1 deletion 2 .markdownlint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
MD013: false
MD033: false
MD033: false # no-inline-html
8 changes: 4 additions & 4 deletions 8 CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To contribute a change, please:

### Developing the cookiecutter template

We quite like installing cookiecutter as a uv tool:
We quite like installing cookiecutter as a [uv tool](https://docs.astral.sh/uv/guides/tools/), so it's available globally:
samcunliffe marked this conversation as resolved.
Show resolved Hide resolved

```sh
uv tool install cookiecutter
Expand All @@ -44,19 +44,19 @@ cookiecutter gh:UCL-ARC/python-tooling --checkout <branch-name>
```

If you have this repo locally (presumably the case if you're developing), you
can run the following:
can instead run the following:

```sh
cookiecutter /path/to/your/checkout/of/python-tooling --checkout <branch-name>
```

Perhaps obvious, you can omit the `--checkout` option if you're already on the
You can omit the `--checkout` option if you're already on the
branch you want to test.

### Developing the recommended tooling pages

Pages all live in the
[docs/pages](https://github.com/UCL-ARC/python-tooling/tree/main/docs/pages)
`docs/pages`
sub-directory, and are written in markdown.

To build the webpage locally (for testing)
Expand Down
2 changes: 1 addition & 1 deletion 2 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you have [uv] installed, you can use our template with the following one-line
uvx cookiecutter gh:ucl-arc/python-tooling --checkout latest
```

You can also [install cookiecutter].
Alternatively you can [install cookiecutter].
samcunliffe marked this conversation as resolved.
Show resolved Hide resolved
Do this if you don't use [uv], or if you're likely to want to use cookiecutter again.
Copy link
Member

Choose a reason for hiding this comment

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

This says "you can do this if you don't use uv", but then the command below uses uv. Perhaps just link to https://cookiecutter.readthedocs.io/en/stable/README.html#installation instead of offering extra commands?

Copy link
Member Author

Choose a reason for hiding this comment

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

I do link to there. Line above ☝️
And I thought "Here's the way we install it" indicated that there are other ways.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we could change

[install cookiecutter]

to

[install cookiecutter] with pipx or pip

to make it clearer that this is distinct from the uv installation instructions and maybe also change

Here's the way we install it:

to

To install cookiecutter using uv run

Copy link
Member Author

Choose a reason for hiding this comment

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

How about just removing the whole thing and directing the user to install cookiecutter following cookiecutter's instructions?

6816c2e

Then it becomes a bit simpler.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Looks good to me!

Here's the way we install it:
samcunliffe marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.