Skip to content

Commit 45ccc40

Browse files
committed
Document docs workflow
1 parent 4c80c96 commit 45ccc40

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For smaller contributions just use this workflow:
1010

1111
- Fork the project.
1212
- Add your features and or bug fixes.
13-
- Add tests. Tests are important for us.
13+
- Add tests to ensure your changes work and will continue working.
1414
- Check your changes using `composer check`.
1515
- Add an entry to the [Changelog's Unreleased section](CHANGELOG.md#unreleased).
1616
- Send a pull request.
@@ -134,6 +134,9 @@ composer bench
134134

135135
We document this library by rendering the Markdown files in [docs](docs) with [MkDocs](https://www.mkdocs.org).
136136

137+
> You may propose changes to the docs via merge requests against the `master` branch.
138+
> Do not edit the generated HTML files in the `gh-pages` branch directly, they are automatically generated.
139+
137140
Generate the class reference docs:
138141

139142
```sh

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ it: fix stan test docs ## Run the commonly used targets
55
help: ## Displays this list of targets with descriptions
66
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
77

8+
.PHONY: setup
9+
setup: vendor ## Set up the project
10+
811
.PHONY: fix
912
fix: rector php-cs-fixer ## Automatic code fixes
1013

0 commit comments

Comments
 (0)