added section on python community standards #894
Conversation
…-adaptive-lessons Instructor Training Lessons: Assessment & Adaptive Lessons
|
|
||
| #### Community standards | ||
|
|
||
| As you begin to develop python packages (i.e., bundled collections of python code) that others are using, or that you're hoping other developers will contribute to, it's useful to adhere to python community standards. Some python community standards that you should be aware of (and ideally adhere to in your own python package) include: |
|
Thanks for the good suggestions @aaren. I'm happy to make these changes if you guys think this would be good additional content (i.e., if there aren't plans to ultimately merge this pull request in some form or another, I won't put more time into it now). Let me know what you think about that. |
|
Also, note I put a screencast together here discussing these topics. |
|
@gregcaporaso I think you meant @arokem :) |
|
yes, that's right. Sorry for the confusion. @arokem, who would be the person to decide if this is ultimately something that swcarpentry would like to include in the lessons? |
|
Me, and yes :-) |
|
Ok, great. I'll make the suggested changes this week. Thanks! Sent from my phone, please excuse typos and brevity.
|
Intermediate MATLAB materials
|
My last push addresses all of @arokem's comments, and merges master. I'm not sure why all of files are showing up as updated in this PR though - my only changes were to @gvwilson, do you want me to close this pull request and open another that contains only the changes in |
|
|
👍 |
|
closed in favor of #930 |
Submitted as part of my final assignment for the Instructor training 11 course.
I think this is very useful information for new python developers, to make them aware of these types of coding and documentation standards as they begin developing their own software. Even if students don't end up being python developers, it's useful for them to know that these types of standards exist so they can try to track them down for their programming language of choice.
If you agree that this is useful information to include in the lessons, I'm happy to relocate, expand/reduce, etc to make it fit best with the existing lessons.