search

citrusframework / citrus

Framework for automated integration tests with focus on messaging integration
https://citrusframework.org
Apache License 2.0
456 stars 134 forks source link

Various documentation fixes #964

Closed picimako closed 1 year ago

picimako commented 1 year ago

Hi!

I've been reading through the Citrus documentation and I've found a handful of small typos and grammatical issues, as well as some minor issues with code snippets.

I've already pushed some of the changes to my fork of Citrus, and I'd be glad to open a PR for that.

I have just one question: if you have no objections, would you like me to open one PR for the typos and another one for the code snippet?

bbortt commented 1 year ago

sure, go on! 😉

christophd commented 1 year ago

@picimako yes, please! this would be very appreciated! If you like open two separate PRs, just what suits best for you.

Recently, I have been working on code samples in documentation, too. So please be sure to update to the latest version before opening the PR, thx.

Also in case your contribution is targeting Citrus 3.x please open the PR towards the respective 3.x branch. Otherwise you can use the main branch that represents Citrus 4.x

Many thanks!

picimako commented 1 year ago

One PR was more convenient, so I've opened https://github.com/citrusframework/citrus/pull/966 against main. :)

christophd commented 1 year ago

@picimako many thanks for your contributions! I think we can close this as completed, right?

picimako commented 1 year ago

@christophd Yeah, you can close it. If I find more such issues later, I'll create a separate issue for that.

christophd commented 1 year ago

Fixed with #966