search

nsryan2 / NEAR

NEAR (Non-Equilibrium Archetypes of Reactors): Houses cyclus archetypes for non-equilibrium reactors with core-loading and enrichment variability.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Create a contributing document #29

Open nsryan2 opened 1 week ago

nsryan2 commented 1 week ago

This repository could probably use a contributing document (like cyclus's).

It should include

  1. That tests must be included for every new feature.
  2. That documentation should accompany updates.
  3. That users cannot merge their own PRs.
  4. What to include in the writing of a PR.
  5. How to tag your PR (tags are required).
    1. Bug Fix = correcting a bug
    2. Documentation = Updates to README's, text documents, licenses, writing
    3. New Feature = Anything that was previously outside the scope of the code. These should be substantial contributions.
    4. Example = Notebooks, code examples, outlines, sample files.
    5. Enhancement = Refinement work on existing features that aren't necessarily bugs, but add value to the work.
  6. How to write an issue.

This issue can be closed by a PR that contains a contributing document with this information.