Skip to content

add coding styleguide #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 5, 2019
Merged

add coding styleguide #460

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83963bb
Update CONTRIBUTING.md
Ir1d Nov 5, 2019
e9071fc
Update CONTRIBUTING.md
williamFalcon Nov 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For example: One benefit of the validation_step is that the user doesn't have to

## Lightning Design Principles
We encourage all sorts of contributions you're interested in adding! When coding for lightning, please follow these principles.
#### No PyTorch interference
#### No PyTorch Interference
We don't want to add any abstractions on top of pure PyTorch. This gives researchers all the control they need without having to learn yet another framework.

#### Simple Internal Code
Expand All @@ -30,12 +30,12 @@ You shouldn't be afraid to upgrade Lightning :)
#### Gain User Trust
As a researcher you can't have any part of your code going wrong. So, make thorough tests that ensure an implementation of a new trick or subbtle change is correct.

## Contribution types
## Contribution Types
Currently looking for help implementing new features or adding bug fixes.

A lot of good work has already been done in project mechanics (requirements.txt, setup.py, pep8, badges, ci, etc...) we're in a good state there thanks to all the early contributors (even pre-beta release)!

## Bug fixes:
## Bug Fixes:
1. Submit a github issue.
2. Fix it.
3. Submit a PR!
Expand All @@ -44,3 +44,7 @@ A lot of good work has already been done in project mechanics (requirements.txt,
1. Submit a github issue.
2. We'll agree on the feature scope.
3. Submit a PR! (with updated docs and tests 🙃).

## Coding Styleguide
1. Test the code with flake8.
Copy link
Collaborator

@Borda Borda Nov 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather say that we follow PEP8 which can be simply tested locally by pylint or flake8

Copy link
Contributor Author

@Ir1d Ir1d Nov 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i remember its a little bit different from autopep8, but i think its okay to change this line 👍

2. Use f-strings.