Skip to content

Commit

Permalink
Update README to fix issue #25
Browse files Browse the repository at this point in the history
  • Loading branch information
kbayliss committed Aug 16, 2023
1 parent 2405767 commit 12e9981
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@

## Unreleased

### Fixed

- Documentation referencing an incorrect CSS import path

## 1.1.0

### Added

- Template linting to CI using `djlint`
Expand Down
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ Run the Python tests with `poetry run pytest`.

If your changes cause snapshot tests to fail, verify that the changes you have caused are expected. Update the snapshots with `poetry run pytest --snapshot-update`.

### Publishing
## Publishing

1. `pre-commit` - run linters
2. `pytest` - run backend tests
3. Bump project version in pyproject.toml and package.json
4. `poetry lock --no-update` - Lock python packages
5. `npm i --package-lock-only` - Lock javascript packages
6. `npm run build` - build NPM package
7. `poetry build` - build python package
8. `npm publish` - publish package to npmjs.com
9. `poetry publish` - publish package to pypi.org
4. Update CHANGELOG headings (add a new heading beneath the "Unreleased" heading)
5. `poetry lock --no-update` - Lock python packages
6. `npm i --package-lock-only` - Lock javascript packages
7. `npm run build` - build NPM package
8. `poetry build` - build python package
9. `npm publish` - publish package to npmjs.com
10. `poetry publish` - publish package to pypi.org
11. Create a [release](https://github.com/torchbox/tbxforms/releases) with relevant changelog entries and upgrade considerations
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Import the styles into your project...
...Either as CSS without any customisations:

```scss
@use 'node_modules/tbxforms/style.css';
@use 'node_modules/tbxforms/dist/style.css';
```

...Or as Sass to customise variables:
Expand Down

0 comments on commit 12e9981

Please sign in to comment.