Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 2.07 KB
Raw

Contributing to WireMock API Templates Library

a

Any contributions to the API Templates library are welcome! Check out the WireMock Contributor Guide for generic guidelines, and see the sections below for particular contributing use-cases.

Reporting issues

Please report any issues or feature requests as GitHub issues in the repository. If you need help with troubleshooting, use the #help channel on WireMock Community Slack.

Adding or updating Templates

We maintain an open source repository of API templates that can be used with WireMock or WireMock Cloud.

If you would like to contribute an API template to enable other WireMock users to build their own mocks based off your template then please checkout the repository.

API Templates Site Development

The website is powered by the Hugo Framework and deployed to AWS Amplify. It is possible to do development on any modern platform.

Prerequisites

  • Operating system: Linux, Windows, macOS
  • Hugo is installed (installation guide)
  • PostCSS is installed, use npm install postcss-cli

Running in the development mode

To run Hugo as a daemon for local development, use the following command:

hugo server -D

After that you will be able to see the website on http://localhost:1313/. Most of the changes to the site source code will be automatically propagated to the local site.

Submitting changes

All changes should be submitted as pull requests, then it will be reviewed and integrated by one of the maintainers. Make sure to follow the pull request template.

Deployment

At the moment the site is automatically deployed to AWS Amplify. If any help with the operations is needed, contact the team in #community-operations on Slack.