contributing docs updates #120
Merged
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
|
@Islast actually I was wanting to know if it was appropriate to change existing code to fit PEP8 style. So it was more a general question. From my perspective, it is unnecessary information to include in the development guide. We will refactor the code(imports +shebangs) so that it won't be confusing to new contributors. |
|
Thanks for the feedback Ruslan. I've changed it to simply note that contributors should feel free to update existing code when it breaks PEP8 |
KirstieJane
approved these changes
Jun 17, 2019
|
|
||
| ### Linting | ||
|
|
||
| scona uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/). | ||
| You can use [flake8](http://flake8.pycqa.org/en/latest/) to lint code. | ||
| We're quite a young project (at time of writing in January 2019) and so we aren't going to be super hardcore about your linting! | ||
| Linting should make your life easier, but if you're not sure how to get started, or if this is a barrier to you contributing to `scona` then don't worry about it or [get in touch](CONTRIBUTING.md#how-to-get-in-touch) and we'll be happy to help you. | ||
| Feel free also to correct unlinted code in scona when you come across it!:sparkles: |
|
Ready to merge @Islast 🚀 |
Closed
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.
What's the context for this pull request?
(this is a good place to reference any issues that this PR addresses)
Issues Update Development guide: Installation instructions #110 and import inside functions #117
What's new?
updated install instructions as suggested in Update Development guide: Installation instructions #110
following import inside functions #117 I have added a short section to the development guide in which to include clarifications on style.
What should a reviewer feedback on?
@KirstieJane I like to keep you pinged in any changes to the contributing docs. It would be great if you could take a glance over and make sure they read well.
@wingedRuslan I've added some bullet points to the development guide. I'd like to know: would seeing something like this have eased the concerns you raised in import inside functions #117? Or was your question a more general one about wanting to know when it was appropriate to change existing code to fit PEP8 style? I'm trying to feed this question back into the developer's guide it would be great to hear your opinion
Does anything need to be updated after merge?
(e.g the wiki or the WhitakerLab website)
nope :)