mirror of
https://github.com/wassname/pytorch-lightning.git
synced 2026-09-09 11:32:07 +08:00
notes on Bug fixing (#2053)
* import * Apply suggestions from code review Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com> Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
This commit is contained in:
co-authored by
Adrian Wälchli
parent
00f1ac11e6
commit
69575204f2
@@ -53,10 +53,17 @@ We are 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...) so we're in a good state there thanks to all the early contributors (even pre-beta release)!
|
||||
|
||||
### Bug Fixes:
|
||||
1. Submit a github issue - try to describe what happened so others can reproduce it too (config, code samples, expected vs. actual behaviour).
|
||||
1. Submit a github issue - try to describe what happened so others can reproduce it too (config, code samples, expected vs. actual behaviour).
|
||||
Note, that the sample code shall be minimal and if needed with publicly available data.
|
||||
2. Try to fix it or recommend a solution...
|
||||
We highly recommend to use test driven approach
|
||||
* convert your minimal code example to a unit/integration test with assert on expected results
|
||||
* start with debugging the issue... you can run just this particular test in your IDE and draft a fix
|
||||
* verify that your test case fails on the master branch and only passes with the fix applied
|
||||
3. Submit a PR!
|
||||
|
||||
_**Note**, even if you do not find the solution, sending a PR with a test covering the issue is a valid contribution and we can help you or finish it with you :]_
|
||||
|
||||
|
||||
### New Features:
|
||||
1. Submit a github issue - describe what is the motivation of such feature (adding the use case or an example is helpful).
|
||||
|
||||
Reference in New Issue
Block a user