diff --git a/MANIFEST.in b/MANIFEST.in index b78dd2e964..4c07f07c31 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,4 @@ include .bumpversion.cfg -include README.rst include LICENSE include commitizen/cz/*.txt global-exclude *.py[cod] __pycache__ *.so *.dylib diff --git a/README.rst b/README.rst deleted file mode 100644 index 34c9284da3..0000000000 --- a/README.rst +++ /dev/null @@ -1,188 +0,0 @@ -============= -Commitizen -============= - - Python 3 command-line utility to standardize commit messages and bump version - - -.. image:: https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg - :alt: Github Actions - :target: https://github.com/Woile/commitizen/actions - -.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square - :alt: Conventional Commits - :target: https://conventionalcommits.org - -.. image:: https://img.shields.io/pypi/v/commitizen.svg?style=flat-square - :alt: PyPI Package latest release - :target: https://pypi.org/project/commitizen/ - -.. image:: https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square - :alt: Supported versions - :target: https://pypi.org/project/commitizen/ - -.. image:: https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square - :alt: Codecov - :target: https://codecov.io/gh/Woile/commitizen - -.. image:: docs/images/demo.gif - :alt: Example running commitizen - --------------- - -**Documentation**: https://Woile.github.io/commitizen/ - --------------- - -.. contents:: - :depth: 2 - - -About -========== - -Commitizen is a tool designed for teams. - -Its main purpose is to define a standard way of committing rules -and communicating it (using the cli provided by commitizen). - -The reasoning behind it is that it is easier to read, and enforces writing -descriptive commits. - -Besides that, having a convention on your commits makes it possible to -parse them and use them for something else, like generating automatically -the version or a changelog. - - -Installation -============= - -:: - - pip install -U commitizen - -:: - - poetry add commitizen --dev - - -**Global installation** - -:: - - sudo pip3 install -U commitizen - -Features -======== - -- Command-line utility to create commits with your rules. Defaults: `conventional commits`_ -- Display information about your commit rules (commands: schema, example, info) -- Bump version automatically using semantic verisoning based on the commits. `Read More <./docs/bump.md>`_ -- Generate a changelog using "Keep a changelog" (Planned feature) - - -Commit rules -============ - -This client tool prompts the user with information about the commit. - -Based on `conventional commits`_ - -This is an example of how the git messages history would look like: - -:: - - fix: minor typos in code - feat: new command update - docs: improved commitizens tab in readme - feat(cz): jira smart commits - refactor(cli): renamed all to ls command - feat: info command for angular - docs(README): added badges - docs(README): added about, installation, creating, etc - feat(config): new loads from ~/.cz and working project .cz .cz.cfg and setup.cfg - -And then, by using ``cz bump`` , you can change the version of your project. - -``feat`` to ``MINOR`` -``fix`` to ``PATCH`` - - -Commitizens -=========== - -These are the available committing styles by default: - -* cz_conventional_commits: `conventional commits`_ -* cz_jira: `jira smart commits `_ - - -The installed ones can be checked with: - -:: - - cz ls - - - -Commiting -========= - -Run in your terminal - -:: - - cz commit - -or the shortcut - -:: - - cz c - - -Usage -===== - -:: - - $ cz --help - usage: cz [-h] [--debug] [-n NAME] [--version] - {ls,commit,c,example,info,schema,bump} ... - - Commitizen is a cli tool to generate conventional commits. - For more information about the topic go to https://conventionalcommits.org/ - - optional arguments: - -h, --help show this help message and exit - --debug use debug mode - -n NAME, --name NAME use the given commitizen (default: - cz_conventional_commits) - --version get the version of the installed commitizen - - commands: - {ls,commit,c,example,info,schema,bump,version,check,init} - ls show available commitizens - commit (c) create new commit - example show commit example - info show information about the cz - schema show commit schema - bump bump semantic version based on the git log - version get the version of the installed commitizen or the - current project (default: installed commitizen) - check validates that a commit message matches the commitizen - schema - init init commitizen configuration - -Contributing -============ - -Feel free to create a PR. - -1. Clone the repo. -2. Add your modifications -3. Create a virtualenv -4. Run :code:`./scripts/test` - - -.. _conventional commits: https://conventionalcommits.org/ diff --git a/docs/index.md b/docs/README.md similarity index 100% rename from docs/index.md rename to docs/README.md diff --git a/docs/check.md b/docs/check.md index 40e763b3b5..e43878700f 100644 --- a/docs/check.md +++ b/docs/check.md @@ -14,11 +14,13 @@ python -m pip install pre-commit * Step 2: Create `.pre-commit-config.yaml` at your root directory with the following content ```yaml -- repo: https://github.com/Woile/commitizen - rev: master - stages: [commit-msg] - hooks: - - id: commitizen +--- +repos: + - repo: https://github.com/Woile/commitizen + rev: v1.16.2 + hooks: + - id: commitizen + stages: [commit-msg] ``` * Step 3: Install the configuration into git hook through `pre-commit` diff --git a/mkdocs.yml b/mkdocs.yml index 5dcfe9305f..dfaa6e16d8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ repo_url: https://github.com/Woile/commitizen edit_uri: "" nav: - - Introduction: 'index.md' + - Introduction: 'README.md' - Configuration: 'config.md' - Commands: - Bump: 'bump.md' @@ -26,4 +26,4 @@ markdown_extensions: guess_lang: false - admonition - codehilite - - extra \ No newline at end of file + - extra diff --git a/pyproject.toml b/pyproject.toml index b8ae33c7a0..75cdb9abb0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,7 +34,7 @@ description = "Python commitizen client tool" authors = ["Santiago Fraire "] license = "MIT" keywords = ["commitizen", "conventional", "commits", "git"] -readme = "README.rst" +readme = "docs/README.md" homepage = "https://github.com/woile/commitizen" classifiers = [ "License :: OSI Approved :: MIT License",