glotzerlab / hoomd-examples

HOOMD-blue example scripts.
BSD 3-Clause "New" or "Revised" License
34 stars 15 forks source link

Add contributor guidelines #3

Closed joaander closed 5 years ago

joaander commented 5 years ago

This PR adds contributor guidelines, issue, and pull request templates to facilitate external contributions to hoomd-examples. The file OUTLINE.md is currently a placeholder to be later filled out with the contents of #2.

As hoomd-examples will be used closely in conjunction with HOOMD, I am including it under the same license and contributor agreement as the parent project going forward.

glotzerlab reviewers, please go ahead and make any obvious fixes or improvements directly and push them to the branch.

bdice commented 5 years ago

Awesome, I really like this layout for the issue / PR templates.

A few items for consideration:

joaander commented 5 years ago

New examples may add digits to insert between existing examples and avoid O(N) renaming:

▶ ls
00-ex1  011-ex-new  01-ex2  02-ex3  03-ex4