Add Twirp Design Principles to the Contributing Guidelines and archive protocol v6 #237
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ofpiyush
reviewed
May 22, 2020
CONTRIBUTING.md
Outdated
| Install them however you feel. | ||
| * Security updates. | ||
| * Performance improvements. | ||
| * Supporting new versions of Golang and Protobug. |
There was a problem hiding this comment.
Suggested change
| * Supporting new versions of Golang and Protobug. | |
| * Supporting new versions of Golang and Protobuf. |
ofpiyush
reviewed
May 22, 2020
CONTRIBUTING.md
Outdated
|
|
||
| ## Developer Loop ## | ||
| In the other hand, contributions that contradict the following priorities will be more difficult: |
There was a problem hiding this comment.
Suggested change
| In the other hand, contributions that contradict the following priorities will be more difficult: | |
| On the other hand, contributions that contradict the following priorities will be more difficult: |
ofpiyush
reviewed
May 22, 2020
CONTRIBUTING.md
Outdated
| Most tests of the Go server are in `internal/twirptest/service_test.go`. Tests | ||
| of cross-language clients are in the [clientcompat](./clientcompat) directory. | ||
| * Twirp officially supports the last 3 releases of Go. | ||
| * The Python implementation uses Python 2.7. |
There was a problem hiding this comment.
Python has stopped official support for 2.7, maybe remove the requirement?
There was a problem hiding this comment.
That is right. However this should be discussed in a different PR. The Python implementation has a few things that should be discussed all together. This PR adds some edits to the Contributing Guidelines, but with the focus on adding the Twirp Principles.
There was a problem hiding this comment.
We edited this point with: "As such, it is not suitable for production use in its current form.". Thanks for the reference.
marioizquierdo
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a list of Twirp Principles to the CONTRIBUTING document, to clarify what are the priorities for the project. Include examples of contributions that are welcome, and examples of contributions that will be difficult. Also update the instructions to run tests and organize the document a little better.
Archive the draft proposition for Twirp v6. Keep a document of the intended changes, to acknowledge those who may have waited for this to happen. Make it clear that v6 is not going to happen.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.