This repository has been archived by the owner on Nov 9, 2021. It is now read-only.
Style guide #67
Draft
Style guide #67
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
|
How does this look, @suricactus? |
suricactus
reviewed
Jul 11, 2019
There was a problem hiding this comment.
Looks awesome!
You mentioned you want to publish 1.1 by the end of this week, but personally, I don't have enough time to change all the files to conform to the style guide. Therefore, I would suggest to enforce it after the release, as there are some nasty bugs already fixed on the dev branch/PRs.
About PEP8/PEP484 part, maybe after the changes you should put a link to a file, that is a good example of usage of these two PEPs. A line of code is worth a thousand words.
|
|
||
| 3. Implement type hints for all functions/methods ([PEP 484](https://www.python.org/dev/peps/pep-0484/)) | ||
|
|
||
| 4. Make sure your code passes all linting and test requirements before submitting your pull request. |
There was a problem hiding this comment.
Suggested change
| 4. Make sure your code passes all linting and test requirements before submitting your pull request. | |
| 4. Make sure your code passes all linting and test requirements before submitting your pull request, using `make lint` and there are no errors in the output. |
| @@ -13,6 +13,10 @@ Whenever dev stabilizes a release is cut and we merge dev in to master. So maste | |||
| It is possible that there may be small releases in quick succession, especially if they are nice improvements that do | |||
| not require lots of updating. | |||
|
|
|||
| ## Contributing | |||
|
|
|||
| Please read the [contributing guide](CONTRIBUTING.md) before submitting any pull requests. | |||
There was a problem hiding this comment.
Suggested change
| Please read the [contributing guide](CONTRIBUTING.md) before submitting any pull requests. | |
| Please read the [contributing guide](CONTRIBUTING.md) before submitting any bug reports or pull requests. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Draft of style guide as per #65