Skip to content

Commit

Permalink
Merge pull request #147 from ferozsalam/add-test-instructions
Browse files Browse the repository at this point in the history
Add local testing instructions to the contributors' guidelines
  • Loading branch information
jertel authored May 10, 2021
2 parents b02922f + a7af4cb commit 582396b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
## Introduction

PRs are welcome, but must include tests, when possible. PRs will not be merged if they do not pass
the automated CI workflows.
the automated CI workflows. To test your changes before creating a PR, run
`sudo make clean; sudo make test-docker` from the root of the repository (requires Docker to be
running on your machine).

Before submitting the PR review that you have included the following changes, where applicable:
- Documentation: If you're adding new functionality, any new configuration options should be documented appropriately in the docs/ folder.
Expand Down Expand Up @@ -42,4 +44,4 @@ Maintainers, when creating a new release, follow the procedure below:
[2]: https://github.com/jertel/elastalert2/actions/workflows/publish_image.yml
[3]: https://github.com/jertel/elastalert2/actions/workflows/python-publish.yml
[4]: https://github.com/jertel/elastalert2/actions/workflows/upload_chart.yml
[5]: https://github.com/jertel/elastalert2/discussions
[5]: https://github.com/jertel/elastalert2/discussions

0 comments on commit 582396b

Please sign in to comment.