chore: updating advice on message processing - Githubissues

bbc / sqs-consumer

Build Amazon Simple Queue Service (SQS) based applications without the boilerplate

https://bbc.github.io/sqs-consumer/

Other

1.71k stars 330 forks source link

chore: updating advice on message processing #366

Closed nicholasgriffintn closed 1 year ago

nicholasgriffintn commented 1 year ago

Resolves #256

Description:

Updated the advice on message processing to make it clearer how to ensure messages are processed one at a time and that messages can be acknowledged.

Type of change:

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Why is this change required?:

It was previously unclear how this functionality works, updating the README makes this clearer.

Code changes:

Updated the README

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[x] All new and existing tests passed.

codeclimate[bot] commented 1 year ago

Code Climate has analyzed commit 58d8bf67 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 94.5% (0.0% change).

View more on Code Climate.