Skip to content

Commit 9a5307d

Browse files
Ir1dwilliamFalcon
authored andcommitted
add coding styleguide (#460)
* Update CONTRIBUTING.md add coding styleguide * Update CONTRIBUTING.md
1 parent 37729f0 commit 9a5307d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For example: One benefit of the validation_step is that the user doesn't have to
88

99
## Lightning Design Principles
1010
We encourage all sorts of contributions you're interested in adding! When coding for lightning, please follow these principles.
11-
#### No PyTorch interference
11+
#### No PyTorch Interference
1212
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.
1313

1414
#### Simple Internal Code
@@ -30,12 +30,12 @@ You shouldn't be afraid to upgrade Lightning :)
3030
#### Gain User Trust
3131
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.
3232

33-
## Contribution types
33+
## Contribution Types
3434
Currently looking for help implementing new features or adding bug fixes.
3535

3636
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)!
3737

38-
## Bug fixes:
38+
## Bug Fixes:
3939
1. Submit a github issue.
4040
2. Fix it.
4141
3. Submit a PR!
@@ -44,3 +44,7 @@ A lot of good work has already been done in project mechanics (requirements.txt,
4444
1. Submit a github issue.
4545
2. We'll agree on the feature scope.
4646
3. Submit a PR! (with updated docs and tests 🙃).
47+
48+
## Coding Styleguide
49+
1. Test the code with flake8.
50+
2. Use f-strings.

0 commit comments

Comments
 (0)