Concept version of a CONTRIBUTING.md

[p0psicles]

First concept version of CONTRIBUTING.md

1. If you want to make a change, like different titles, paragraph order, etc. Then please let me know here, or in irc. And i'll change it.
2. If you want to add a chapter. For example, some more in depth Javascript guidelines, please add them yourself.
3. If you think any grammatical improvements can be made, please make them!

I'll keep this open for 1 week.

• Read contribution guide
• PR is based on the DEVELOP branch
• Don't send big changes all at once. Split up big PRs into multiple smaller PRs that are easier to manage and review

[ratoaq2]

Should we add PEP257 as well?
Talking about docstrings, I like to have the docstrings with the parameter types and return types, since they help a lot my IDE helping myself.
What are the opinions from you all?

[medariox]

My suggestion would be that we try to standardize our code as much as possible by forcing new PRs to pass specific conventions.

In my opinion, these should be mandatory:

• pep8
• pyflakes
• pydocstyle (PEP257)
• Import-order style: cryptography or google or PEP8 default
• Max line length: 119

That's my opinion. What do you think?

[ratoaq2]

Take a look in this proposal:
#836

[OmgImAlexis]

I'd love to convert to the JS style guide used at Airbnb but there's still a LOT of changes that'll need to be made before that's possible. I'll finally have internet back in the next 14 days so I'll be able to start work on this if everyone is okay with that. I'd also like to know officially what versions of browsers we support so I can start removing old js code that's mainly for outdated browsers.

One of first things that comes into mind is using const and let vs var which is only supported by modern browsers this would mean we'd need to drop support for IE10 which I'm not sure if we can do. I need to have a look at the logs we've got from cdn.pymedusa.com first to see how many of the users are using anything below IE11.

[p0psicles]

Can this be approved?

[fernandog]

Approved

[coveralls]

Coverage remained the same at 28.874% when pulling 708e7bf on contributing into bf4efd0 on develop.

[OmgImAlexis]

Is there a reason Google's was chosen over AirBNB's?

[p0psicles]

No. Just want to get starting with something. And as where going towards Angular, googles guidelines seemed logic. If you wanna take care of the js guidelines. Great!

Where now on slack with for the devs channel. Come to IRC for the invite.

[OmgImAlexis]

For the JS devs I've also been looking into https://github.com/sindresorhus/xo instead of jshint and the current style/lint guide we use.