Skip to content
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.

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

Rewrite README to incorporate versioning guidance #123

Merged
merged 4 commits into from
May 9, 2022
Merged

Conversation

benthorner
Copy link
Contributor

https://trello.com/c/fRihmgQ8/266-add-top-level-guidance-about-where-we-write-tests-on-govuk

This tidies up the README a bit to provide a structure
for adding further guidance about the versioning scheme
used by this fork of Pact Broker.

Please see the commits for more details.

Ben Thorner added 2 commits April 22, 2022 09:36
This simplifies the README so it's focussed on getting started with
the app, as well as placing more emphasis on further documentation.
This is part of work to rewrite the "Pact Broker" dev doc [^1] so
that it's focussed on writing tests, not details about this repo.

[^1]: https://github.com/alphagov/govuk-developer-docs/blame/f8c7344ae79f333cd927cfb9ba30be2d2ee58fa4/source/manual/pact-broker.html.md#L54
benthorner pushed a commit to alphagov/govuk-developer-docs that referenced this pull request Apr 22, 2022
Copy link
Member

@kevindew kevindew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job, just a couple of suggestions.

docs/versioning.md Outdated Show resolved Hide resolved
docs/infrastructure.md Show resolved Hide resolved
benthorner pushed a commit that referenced this pull request Apr 27, 2022
Copy link
Contributor

@ChrisBAshton ChrisBAshton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for all the comments - the perils of markdown split over hard newlines!

docs/infrastructure.md Show resolved Hide resolved
docs/versioning.md Outdated Show resolved Hide resolved
docs/versioning.md Outdated Show resolved Hide resolved
docs/versioning.md Outdated Show resolved Hide resolved
docs/versioning.md Outdated Show resolved Hide resolved
docs/versioning.md Outdated Show resolved Hide resolved
@benthorner benthorner merged commit 643dc3e into main May 9, 2022
@benthorner benthorner deleted the rewrite-readme branch May 9, 2022 16:56
benthorner pushed a commit to alphagov/govuk-developer-docs that referenced this pull request May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants