search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

CONTRIBUTING.md Missing #9

Closed nuclearGoblin closed 2 years ago

nuclearGoblin commented 3 years ago

From matthewfeickert in openjournals/joss-reviews#3174 on 04/29/21

There is no CONTRIBUTING.md, no descriptions of using GitHub Issues for bug tracking, no description of using GitHub Discussions, and also no code of conduct.

Description: CONTRIBUTING.md or something equivalent is non-existent.

Solution: Create a clear and complete document outlining use of GitHub issues, description of using GitHub discussions, and code of conduct.

Testing: N/A

nuclearGoblin commented 3 years ago

There is now a placeholder CONTRIBUTING.md and villaa and I are collaborating on an outline for its contents.

matthewfeickert commented 3 years ago

While not required in the JOSS review criteria for Community guidelines a Code of Conduct is a great thing to have.

villaa commented 2 years ago

As part of this I wonder if we can make a "ReleaseNotes.md" which are updated with staged release notes for the next release.

villaa commented 2 years ago

PR #19 resolves these issues.