diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4b7664d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,102 @@ +# How to contribute to Solace Quarkus Extension + +We'd love for you to contribute and welcome your help. Here are some guidelines to follow: + +- [Issues and Bugs](#issue) +- [Submitting a fix](#submitting) +- [Feature Requests](#features) +- [Questions](#questions) + +## Did you find a issue? + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/SolaceCoEExt/solace-quarkus/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/SolaceCoEExt/solace-quarkus/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +## Did you write a patch that fixes a bug? + +Open a new GitHub pull request with the patch following the steps outlined below. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +Before you submit your pull request consider the following guidelines: + +* Search [GitHub](https://github.com/SolaceCoEExt/solace-quarkus/pulls) for an open or closed Pull Request + that relates to your submission. You don't want to duplicate effort. +* Make sure you add integration test for the fix you are submitting. +* If your fix is adding a new configuration make sure it is documented in docs/ folder of this project. + +### Submitting a Pull Request + +Please follow these steps for all pull requests. These steps are derived from the [GitHub flow](https://help.github.com/articles/github-flow/). + +#### Step 1: Fork + +Fork the project [on GitHub](https://github.com/SolaceCoEExt/solace-quarkus) and clone your fork +locally. + +```sh +git clone https://github.com//solace-quarkus +``` + +#### Step 2: Branch + +Make your changes on a new git branch in your fork of the repository. + +```sh +git checkout -b my-fix-branch master +``` + +#### Step 3: Commit + +Commit your changes using a descriptive commit message. + +```sh +git commit -a -m "Your Commit Message" +``` + +Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +#### Step 4: Rebase (if possible) + +Assuming you have not yet pushed your branch to origin, use `git rebase` (not `git merge`) to synchronize your work with the main +repository. + +```sh +$ git fetch upstream +$ git rebase upstream/master +``` + +If you have not set the upstream, do so as follows: + +```sh +$ git remote add upstream https://github.com/SolaceCoEExt/solace-quarkus +``` + +If you have already pushed your fork, then do not rebase. Instead merge any changes from master that are not already part of your branch. + +#### Step 5: Push + +Push your branch to your fork in GitHub: + +```sh +git push origin my-fix-branch +``` + +#### Step 6: Pull Request + +In GitHub, send a pull request to `solace-quarkus:main`. + +When fixing an existing issue, use the [commit message keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) to close the associated GitHub issue. + +* If we suggest changes then: + * Make the required updates. + * Commit these changes to your branch (ex: my-fix-branch) + +That's it! Thank you for your contribution! + +## **Do you have an ideas for a new feature or a change to an existing one?** + +* Open a GitHub [enhancement request issue](https://github.com/SolaceCoEExt/solace-quarkus/issues/new) and describe the new functionality. + +## Do you have questions about the source code? + +* Ask any question about the code or how to use Solace messaging in the [Solace community](http://dev.solace.com/community/). \ No newline at end of file diff --git a/README.md b/README.md index 5e54ade..aabae2a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Solace Quarkus Extension for integrating with Solace PubSub+ message brokers. The extension provides the ability to publish or consume events from event mesh. -Samples folder has examples on how to use the connector - [solace-connector-sample](https://github.com/SolaceCoEExt/solace-quarkus/tree/main/samples/hello-connector-solace/src/main/java/io/quarkiverse/solace/samples) +Samples folder has examples on how to use the connector - [solace-connector-sample](https://github.com/SolaceCoEExt/solace-quarkus/tree/main/samples/hello-connector-solace/src/main/java/com/solace/quarkus/samples) ## Documentation @@ -19,3 +19,20 @@ The documentation for this extension should be maintained as part of this reposi ```quarkus build --no-tests``` to build the extension without running tests ```quarkus dev``` run this command in the samples project folder to start the connector. + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. + +## License + +This project is licensed under the Apache License, Version 2.0. - See the [LICENSE](LICENSE) file for details. + +## Resources + +For more information try these resources: + +- The Solace Developer Portal website at: http://dev.solace.com +- Get a better understanding of [Solace technology](http://dev.solace.com/tech/). +- Check out the [Solace blog](http://dev.solace.com/blog/) for other interesting discussions around Solace technology +- Ask the [Solace community.](http://dev.solace.com/community/) diff --git a/pom.xml b/pom.xml index fe70300..b3de769 100644 --- a/pom.xml +++ b/pom.xml @@ -24,9 +24,9 @@ - scm:git:git@github.com:quarkiverse/quarkus-solace.git - scm:git:git@github.com:quarkiverse/quarkus-solace.git - https://github.com/quarkiverse/quarkus-solace + scm:git:git@github.com:SolaceCoEExt/solace-quarkus.git + scm:git:git@github.com:SolaceCoEExt/solace-quarkus.git + https://github.com/SolaceCoEExt/solace-quarkus