Review: writing_good_code.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation, localization
Research direction
Open lectures/writing_good_code.md in the French repository and compare it with the English source at the linked path. Review meaning, technical terms, terminology consistency, academic French, and code comments while following the exclusions in the issue; done when a PR for this file is merged or the reviewer confirms no changes are needed.
Written by the indexing model from the issue text.
Description
Part of #40 (Phase 1).
Native-speaker review of writing_good_code.md by @Honaminto.
| French (read this) | lectures/writing_good_code.md |
| English source | lectures/writing_good_code.md |
How to reply. Open a PR editing the French directly — one PR for this lecture, titled e.g. [writing_good_code] Corrections — or leave line comments / suggestion blocks on it. Priorities: meaning errors, wrong technical terms, inconsistent terminology, unnatural French (academic register), anything in code comments that looks wrong. Ignore spacing before : ; ! ?, errors in the English, and the translation: header. A wrong term that recurs belongs on the terminology issue, not here.
Done when a PR by @Honaminto touching this file is merged, or he states here that the lecture needs no change. Either outcome is recorded; nothing is ticked by hand.
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- Avg merge
- 41m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from QuantEcon/lecture-python-programming.fr
-
Review: debugging.md Openaudit maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
audit maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
audit maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Review: numba.md Openaudit maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
audit maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
All issues in QuantEcon/lecture-python-programming.fr
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100