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.

Sign up for GitHub

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

Add local testing instructions to the contributors' guidelines #147

Merged
merged 4 commits into from
May 10, 2021
Merged

Add local testing instructions to the contributors' guidelines #147

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b156de
Add local testing instructions to the contributors' guidelines
May 10, 2021
019a45a
Merge branch 'master' into add-test-instructions
May 10, 2021
f488769
Updated testing instructions
May 10, 2021
a7af4cb
Merge branch 'master' into add-test-instructions
jertel May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
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