From 73939df05d38a3743f22e79d5568956363f3c271 Mon Sep 17 00:00:00 2001 From: MEHRSHAD MIRSHEKARY Date: Fri, 8 Nov 2024 21:28:29 +0330 Subject: [PATCH] refactor(README): Fix Typos in package documentation --- CODE_OF_CONDUCT.md | 2 +- README.md | 6 +++--- pyproject.toml | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index beb9be7..65b592f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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: diff --git a/README.md b/README.md index 8f838ff..f353f8f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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``: @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 6af956c..83cc2e3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -248,7 +248,7 @@ version = "1.0.0" tag_format = "v$version" [tool.commitizen.settings] -increment_types = [ "feat", "fix" ] +increment_types = [ "feat", "fix", "refactor" ] [tool.semantic_release] assets = [ ]