search

openoakland / OakCrime-Decommissioned

Code supporting citizen analysis of crime in Oakland, CA
22 stars 16 forks source link

Replace settings bits #55

Closed rbelew closed 5 years ago

rbelew commented 5 years ago

putting back header and footer bits of settings.py:

adborden commented 5 years ago

:+1:

  • the initial variables are expected in some communities, cf. PythonGuidelines and sometimes useful for doc generation (eg, epydoc)

^ This would be good to mention in CONTRIBUTING.md under a Documentation section.

  • i find the echoing of environment useful when i port this around, and sometimes have software processing logs assuming this. but i've commented these lines out.

^ This I would mention as a code comment above the print statements. I suggest converting the print statements to proper log.debug statements so it's more clear they are for debugging.

adborden commented 5 years ago

@clintonb your comments are totally spot-on. However, @rbelew expressed at OO last night that he wanted to make the priority on working code over perfect code. We might want to turn some of your comments into GH issues to tackle later. I'm going to add this priority to CONTRIBUTING.md so the team is on the same page.

clintonb commented 5 years ago

My aim has not been to attain perfect code, but to understand why these things are needed. My primary goal has been to make the project usable and accessible to new contributors.

Tools like Pylint, pycodestyle, and isort make it easy to maintain code quality in an automated fashion. If you solely prioritize “working code” you run the risk of accruing a large amount of technical debt that will make it nearly impossible/undesirable for anyone to want to contribute to the project.

On Wed, Jan 30, 2019 at 8:55 AM Aaron D Borden notifications@github.com wrote:

@clintonb https://github.com/clintonb your comments are totally spot-on. However, @rbelew https://github.com/rbelew expressed at OO last night that he wanted to make the priority on working code over perfect code. We might want to turn some of your comments into GH issues to tackle later. I'm going to add this priority to CONTRIBUTING.md so the team is on the same page.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/openoakland/OakCrime/pull/55#issuecomment-459020935, or mute the thread https://github.com/notifications/unsubscribe-auth/AA3krk9vLOWEpo1AYTh5tLLPHHzijX0Iks5vIc5kgaJpZM4aW_FI .

-- Clinton

rbelew commented 5 years ago

what Aaron said. explaining to you why various parts of the current code base are the way they are will take some time. some may reflect code practices i won't try to defend, others are there for reasons you may or not agree with. but getting an operational code base out where it is useful is our current project "towardsV1" goal, and i guess we disagree as to whether it can be "... accessible to new contributors" during this stage. i'm grateful to you, pylint, etc, for pointing out flaws, and we're going to try to capture them all as issues.