Skip to content

Commit a531f79

Browse files
committed
Move the contributing guide to the documentation and publish it on the site
1 parent 4d25835 commit a531f79

File tree

6 files changed

+72
-36
lines changed

6 files changed

+72
-36
lines changed

CONTRIBUTING.md

-31
This file was deleted.

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ WireMock can run in unit tests, as a standalone process or a container. Key feat
2323

2424
- [Testcontainers Python](https://github.com/testcontainers/testcontainers-python) module to easily start WireMock server for your tests
2525
- REST API Client for a standalone WireMock Java server
26-
- Support for most of ajor [WireMock features ](https://wiremock.org/docs) (more on their way soon)
26+
- Support for most of major [WireMock features ](https://wiremock.org/docs) (more on their way soon)
2727

2828
## References
2929

@@ -33,9 +33,13 @@ WireMock can run in unit tests, as a standalone process or a container. Key feat
3333

3434
## Examples
3535

36-
There are several [example projects](./examples/) included to demonstrate the different ways that wiremock can be used to mock
36+
There are several [example projects](./examples/) included to demonstrate the different ways that WireMock can be used to mock
3737
services in your tests and systems. The example test modules demonstrate different strategies for testing against
3838
the same "product service" and act as a good demonstration of real world applications to help you get started.
3939

4040
- [Testcontainers Python](examples/intro/tests/test_testcontainers.py)
4141
- [Standalone Java Server Version](examples/intro/tests/test_java_server.py)
42+
43+
## Contributing
44+
45+
See the [Contributor Guide](./docs/CONTRIBUTING.md)

docs/CONTRIBUTING.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to Python WireMock
2+
3+
[![a](https://img.shields.io/badge/slack-%23wiremock%2Fpython-brightgreen?style=flat&logo=slack)](https://slack.wiremock.org/)
4+
5+
WireMock exists and continues to thrive due to the efforts of over 150 contributors, and we continue to welcome contributions to its evolution. Regardless of your expertise and time you could dedicate, there’re opportunities to participate and help the project!
6+
7+
This page covers contributing to _Python WireMock_.
8+
For generic guidelines and links to other technology stacks,
9+
see [this page](https://wiremock.org/docs/participate/).
10+
11+
## Get Started
12+
13+
1. Join us ion the `#wiremock-python` channel on the [WireMock Slack](https://slack.wiremock.org/)
14+
2. Check out the GitHub issues!
15+
16+
## Pull Requests
17+
18+
All patches to the repository are done via pull requests.
19+
No special prerequisites exist, you can just submit the patches!
20+
General expectations:
21+
22+
- All Tests and static checkers must pass
23+
- Code coverage shouldn't decrease
24+
- All Pull Requests should be rebased against master **before** submitting the PR.
25+
- The Pull Request titles represent the change well for users or developers
26+
27+
## Development
28+
29+
We use [Poetry](https://python-poetry.org/) for packaging and dependency management.
30+
31+
After forking and cloning the repository,
32+
run the following command to setup the project:
33+
34+
`poetry install`
35+
36+
Then use your favorite IDE for development and testing.
37+
38+
## Contributing examples
39+
40+
Please submit new examples as a pull requests to the [examples directory](./examples/).
41+
You can also also add links to external examples and tutorials to the `README.md`
42+
file in the directory.
43+
44+
When adding new examples,
45+
make sure to update the [documentation site page](./examples.md) too.
46+
47+
## Working on Documentation
48+
49+
The documentation is powered by [MkDocs](https://www.mkdocs.org/) and [ReadTheDocs](https://readthedocs.org/).
50+
All the necessary dependencies are included into the Poetry definition.
51+
To build the docs locally:
52+
53+
```bash
54+
poetry run mkdocs build --site-dir=html
55+
```
56+
57+
MkDocs also comes with a built-in dev-server that lets you preview your documentation as you work on it by running the `mkdocs serve` command.
58+
By default, it will deploy the live documentation site to `http://localhost:8000`.
59+
60+
## See also
61+
62+
- [Contributing to WireMock](https://wiremock.org/docs/participate/)

docs/examples.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
## External examples
1010

1111
No external examples are referenced at the moment.
12-
Please be welcome to [contribute]([./../CONTRIBUTING.md](https://github.com/wiremock/python-wiremock/blob/master/CONTRIBUTING.md))!
12+
Please be welcome to [contribute](./CONTRIBUTING.md)!
1313

1414
## Contributing examples
1515

1616
More examples are always welcome!
17-
See the [Contributor Guide]([./../CONTRIBUTING.md](https://github.com/wiremock/python-wiremock/blob/master/CONTRIBUTING.md)).
17+
See the [Contributor Guide](./CONTRIBUTING.md).

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## External examples
99

1010
No external examples are referenced at the moment.
11-
Please be welcome to [contribute](./../CONTRIBUTING.md)!
11+
Please be welcome to [contribute](.CONTRIBUTING.md)!
1212

1313
## Contributing
1414

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ nav:
1515
- Installation: install.md
1616
- Testcontainers: testcontainers.md
1717
- Standalone: api-client.md
18+
- Contributing: CONTRIBUTING.md
1819
- Resources:
1920
- Examples: examples.md
2021
- Changelog: changelog.md

0 commit comments

Comments
 (0)