Skip to content

Commit ad82468

Browse files
committed
README update
1 parent 3d2cfb1 commit ad82468

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ All tests are located within the `tests/` directory and implemented with the [py
1212

1313
Most modules have a corresponding test module (e.g. `aiidalab_launch/instance.py` and `tests/test_instance.py`) which contain unit and integration tests related to that module.
1414

15-
We use the [pytest fixture system](https://docs.pytest.org/en/7.1.x/explanation/fixtures.html#about-fixtures) to create an isolated environment such that the user's actual configuration and docker environment (if available) are not affected.
15+
We use the [pytest fixture system](https://docs.pytest.org/en/7.4.x/explanation/fixtures.html#about-fixtures) to create an isolated environment such that the user's actual configuration and docker environment (if available) are not affected.
1616
For example, we ensure that we monkeypatch the `Path.home()` function to not point to the actual home directory with the [`home_path` fixture](https://github.com/aiidalab/aiidalab-launch/blob/73fe854e525d1c0adfa1f92b1aa97842df5a5c16/tests/conftest.py#L90-L95).
1717

1818
Most fixtures that protect the user's environment are class-scoped and auto-used.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![codecov](https://codecov.io/gh/aiidalab/aiidalab-launch/branch/main/graph/badge.svg?token=7FOZR20CHS)](https://codecov.io/gh/aiidalab/aiidalab-launch)
77
[![Commit Activity](https://img.shields.io/github/commit-activity/m/aiidalab/aiidalab-launch.svg)](https://github.com/aiidalab/aiidalab-launch/pulse)
88

9-
AiiDAlab Launch makes it easy to run AiiDAlab on your own workstation or laptop.
9+
AiiDAlab Launch makes it easy to run [AiiDAlab](https://www.aiidalab.net) on your own workstation or laptop.
1010

1111
## Getting Started
1212

@@ -120,12 +120,15 @@ This will:
120120
Additional notes:
121121

122122
- Use the `--dry` option to preview the release change.
123+
- The release should be created directly on the `main` branch,
124+
and as such you need special permissions for writing to it.
123125
- The release tag (e.g. a/b/rc) is determined from the last release.
124126
Use the `--tag` option to switch the release tag.
125127

126128
## Authors
127129

128130
* **Carl Simon Adorf (EPFL)** - [@csadorf](https://github.com/csadorf)
131+
* [AiiDAlab team](https://www.aiidalab.net/about/)
129132

130133
See also the list of [contributors](https://github.com/aiidalab/aiidalab-launch/contributors).
131134

0 commit comments

Comments
 (0)