Merge branch '65-feature-clean-up-repository-beautify-docs-and-attach…

…-license-to-make-it-public' of https://github.com/zaphiro-technologies/protobuf into 65-feature-clean-up-repository-beautify-docs-and-attach-license-to-make-it-public

CONTRIBUTING.md

@@ -3,17 +3,32 @@
 If you have never made an open source contribution before, here it's a quick
 guide:
 
-1. Find an issue that you are interested in addressing or a feature that you would like to add.
-1. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
-1. Clone the repository to your local machine using `git clone https://github.com/github-username/repository-name.git`.
+1. Find an issue that you are interested in addressing or a feature that you
+   would like to add.
+1. Fork the repository associated with the issue to your local GitHub
+   organization. This means that you will have a copy of the repository under
+   your-GitHub-username/repository-name.
+1. Clone the repository to your local machine using
+   `git clone https://github.com/github-username/repository-name.git`.
 1. Create a new branch for your fix using `git checkout -b branch-name-here`.
-1. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
-1. Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
-1. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
-1. Push the changes to the remote repository using `git push origin branch-name-here`.
+1. Make the appropriate changes for the issue you are trying to address or the
+   feature that you want to add.
+1. Use `git add insert-paths-of-changed-files-here` to add the file contents of
+   the changed files to the "snapshot" git uses to manage the state of the
+   project, also known as the index.
+1. Use `git commit -m "Insert a short message of the changes made here"` to
+   store the contents of the index with a descriptive message.
+1. Push the changes to the remote repository using
+   `git push origin branch-name-here`.
 1. Submit a pull request to the upstream repository.
-1. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so *"Added more log outputting to resolve #4352"*.
-1. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+1. Title the pull request with a short description of the changes made and the
+   issue or bug number associated with your change. For example, you can title
+   an issue like so _"Added more log outputting to resolve #4352"_.
+1. In the description of the pull request, explain the changes that you made,
+   any issues you think exist with the pull request you made, and any questions
+   you have for the maintainer. It's OK if your pull request is not perfect (no
+   pull request is), the reviewer will be able to help you fix any problems and
+   improve it!
 1. Wait for the pull request to be reviewed by a maintainer.
 1. Make changes to the pull request if the reviewing maintainer recommends them.
 1. Celebrate your success after your pull request is merged!

README.md

@@ -67,8 +67,7 @@ go get -v github.com/zaphiro-technologies/protobuf/[email protected]
 
 ## Examples
 
-For your convenience, in the [examples](examples) folder we provide
-Go code to:
+For your convenience, in the [examples](examples) folder we provide Go code to:
 
 - Produce and consume measurements (uses RabbitMQ streams).
 - Produce and consume faults (uses RabbitMQ exchanges).
@@ -133,8 +132,8 @@ need to set-up the dependencies listed in [Requirements](#requirements).
 
 Protocol buffers are versioned (current version is v1), and should be developed
 following best practices, as implemented by [Buf](https://buf.build) and defined
-in [Protobuf programming
-guides](https://protobuf.dev/programming-guides/dos-donts/).
+in
+[Protobuf programming guides](https://protobuf.dev/programming-guides/dos-donts/).
 In particular, it is important - even more within the same version - to preserve
 compatibility, to avoid services breaking up.