minghuaw / fe2o3-amqp

A rust implementation of the AMQP1.0 protocol based on serde and tokio.
MIT License
58 stars 7 forks source link

Created LICENSE.txt and CONTRIBUTING.txt based on standard MIT license #234

Closed LarryOsterman closed 5 months ago

LarryOsterman commented 5 months ago

Created a template LICENSE.txt and CONTRIBUTING file to add license information to the repo source as well as the github repository.

First cut at instructions and guidelines for contributors to the repository.

The CONTRIBUTING.md file is going to need more work to fill in the missing sections, but it functions as a placeholder for the code.

Since this is my first commit to this repo, I would appreciate any feedback, especially on the CONTRIBUTING.md file - the text was taken from the Azure SDK for C++'s CONTRIBUTING.md file with all the Azure SDK specific text removed.

If you have any questions, please feel free to reach out at larryo (at) microsoft.com.

minghuaw commented 5 months ago

Thank you for the PR. I am good with the template, and I am going to fill in the missing sections later today (mainly to help folks to get started and some reference materials)

LarryOsterman commented 5 months ago

Ok, now I feel profoundly incompetent (I suspect that is largely because I've not dealt with github repos without an owners.txt).

How do I go about completing the pull request? The only option I seem to have available is "Close with comment", which is unlikely to achieve my desired goal :).

I suspect this might end up being another item for the "Contributing.md" file :).

minghuaw commented 5 months ago

I meant that I will add to the missing section directly in this PR. I have just filled in the missing sections. Would you mind taking a quick look? Just want to know if that part make sense for folks who are not familiar with rust and AMQP

LarryOsterman commented 5 months ago

I meant that I will add to the missing section directly in this PR. I have just filled in the missing sections. Would you mind taking a quick look? Just want to know if that part make sense for folks who are not familiar with rust and AMQP

Things seem to work ok, with one caveat:

4 tests (broker_connection_compat) fail in fe2o3:

running 4 tests
test activemq_artemis_connection ... FAILED
test rabbitmq_amqp10_connection ... FAILED
test activemq_artemis_sasl_plain_connection ... FAILED
test rabbitmq_amqp10_sasl_plain_connection ... FAILED

My strong suspicion based on the panic message is that they're failing because there is no local AMQP broker running, but the contributiong.md file doesn't include information on how to fetch a local broker (I know that information is in the README.md file though).

minghuaw commented 5 months ago

4 tests (broker_connection_compat) fail in fe2o3:

Good catch. These four actually requires docker. I have added docker to the pre-req. I will merge this if it looks good to you