Skip to content

Commit

Permalink
refactor(README): Fix Typos in package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MEHRSHAD-MIRSHEKARY committed Nov 8, 2024
1 parent cb3ebdf commit 909ef2a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ we’re thrilled that you want to contribute to `dj-data-generator`! to ensure a

9. **Generate Changelog**: Create a changelog with Commitizen(only for the new version tag):
```bash
cz changelog --increamental
cz changelog --incremental
```
the `--incremental` option limits changelog updates to only the new version tag, leaving previous entries unchanged. After generating the changelog, add it to the staging area and commit it manually:

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ INSTALLED_APPS = [

After setting up the package, run the `generate_data` management command to generate fake data for project models

First, generate the audiences using the ``generate_audiences`` command:
using the ``generate_data`` command:

```shell
$ python manage.py generate_data --num-records=1000
Expand Down Expand Up @@ -146,7 +146,7 @@ $ python manage.py generate_data --num-records 1000
Example:

```bash
$ python manage.py generate_audiences --skip-confirmation
$ python manage.py generate_data --skip-confirmation
```

- ``model``:
Expand Down Expand Up @@ -220,7 +220,7 @@ Below is a detailed description of each setting, so you can better understand an

**Default**: ``[]`` (empty list)

**Description**: Specifies a list of app labels that should be excluded when running the `generate_data` command. If certain apps should not be considered for audience generation, list them here. For example:
**Description**: Specifies a list of app labels that should be excluded when running the `generate_data` command. If certain apps should not be considered for data generation, list them here. For example:

```python

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,11 @@ B104 = { check_typed_list = true }

[tool.commitizen]
name = "cz_conventional_commits"
version = "1.0.0"
version = "1.0.1"
tag_format = "v$version"

[tool.commitizen.settings]
increment_types = [ "feat", "fix" ]
increment_types = [ "feat", "fix", "refactor" ]

[tool.semantic_release]
assets = [ ]
Expand Down

0 comments on commit 909ef2a

Please sign in to comment.