Skip to content

Remove redundant readme #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

woile merged 4 commits into commitizen-tools:master from Lee-W:remove-redundant-readme

Feb 20, 2020

Merged

Remove redundant readme #136

Changes from all commits

Commits

Show all changes

Select commit Hold shift + click to select a range

docs(check): fix pre-commit setup

Lee-W Feb 20, 2020

docs(check): pin pre-commit to v1.16.2

Lee-W Feb 20, 2020

refactor(docs): remove README.rst and use docs/README.md

Lee-W Feb 20, 2020

fix: replace README.rst with docs/README.md in config files

Lee-W Feb 20, 2020

File filter

Filter by extension

Conversations

Jump to

Jump to file

Failed to load files.

Loading

Diff view

Diff view

1 change: 0 additions & 1 deletion MANIFEST.in

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
		@@ -1,5 +1,4 @@
		include .bumpversion.cfg
	include README.rst
		include LICENSE
		include commitizen/cz/*.txt
		global-exclude .py[cod] __pycache__ .so *.dylib

188 changes: 0 additions & 188 deletions README.rst

Show comments View file Open in desktop

This file was deleted.

0 docs/index.md → docs/README.md

Show comments View file Open in desktop

File renamed without changes.

12 changes: 7 additions & 5 deletions docs/check.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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`
Expand Down

4 changes: 2 additions & 2 deletions mkdocs.yml

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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'
Expand All		@@ -26,4 +26,4 @@ markdown_extensions:
		guess_lang: false
		- admonition
		- codehilite
	- extra
	- extra

2 changes: 1 addition & 1 deletion pyproject.toml

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,7 +34,7 @@ description = "Python commitizen client tool"
		authors = ["Santiago Fraire <santiwilly@gmail.com>"]
		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",
Expand Down