Taking this to the next level

LibreTexts / ngshare

nbgrader sharing service

https://ngshare.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

17 stars 17 forks source link

Taking this to the next level #72

Closed willingc closed 4 years ago

willingc commented 4 years ago

Great work so far. You have a cool project here.

I would recommend trying a few things to improve code maintainability down the road:

set up a CI system for testing (CircleCI, Azure Pipelines, whatever)
set up a code coverage tool for automated reporting
add some documentation deployed on ReadTheDocs
add badges for the above into the top of the main README
consider adding the black project for python code consistency

Well done. cc/ @moorepants

lxylxy123456 commented 4 years ago

I have been working on these, and here are the results so far (need to wait for everything to merge into master before some badges can display correctly)

I am using Travis CI (same as nbgrader)
Badges are added: https://github.com/lxylxy123456/ngshare/tree/sudo-black-travis-docs#ngshare
Coding style will be black (very convenient to use)
Code coverage > 98%: https://codecov.io/gh/lxylxy123456/ngshare/commit/3346f6782fab553141d2df7c47ce8709930a7360
Some documents are up: https://ngshare.readthedocs.io/en/sudo-black-travis-docs/

moorepants commented 4 years ago

Nice work on all this!

willingc commented 4 years ago

Way to go @lxylxy123456! I made some suggestions on the open PRs not as a criticism but as a way for you to learn :cake:

willingc commented 4 years ago

@lxylxy123456 I think you have completed all of the above suggestions so I am going to close this.