bigbang icon indicating copy to clipboard operation
bigbang copied to clipboard

Published 20 hours ago • verified publisher icon datactive

contributor guidelines

Open npdoty opened this issue 6 years ago • 3 comments

Can we provide some basic guidelines for contributors?

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Might want to include:

  • how/where to write tests for new features
  • license, etc.
  • how to separate scientific code from core library code
  • maybe links to the GitHub guidance for git workflows?

npdoty avatar Apr 04 '18 05:04 npdoty

#450 helped with the tests piece, but could still use contributor guidelines as part of GitHub interface.

npdoty avatar Apr 20 '21 18:04 npdoty

Include PEP 8 style in this.

sbenthall avatar Dec 06 '21 22:12 sbenthall

Wait a second -- these are already in the README! This issue can be closed.

BUT -- there's one question which is whether this should be (a) in the README, (b) in RTD, or (c) both.

Once we settle that and if necessary population RTD then this case is closed.

sbenthall avatar Dec 07 '21 16:12 sbenthall