Skip to content

Commit

Permalink
Expanded README to add in guide for contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
espottesmith committed Oct 7, 2024
1 parent cd2f58e commit b6f7281
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,14 @@ The complete documentation for `RNMC` can be found [here](https://blaugroup.gith

## Dependencies

RNMC depends on [GSL](https://www.gnu.org/software/gsl/) for pseudo random number generation and [sqlite](https://www.sqlite.org/index.html) for the database interfaces.
RNMC depends on [GSL](https://www.gnu.org/software/gsl/) for pseudo random number generation and [sqlite](https://www.sqlite.org/index.html) for the database interfaces.

## Contributing

We welcome community contributions to RNMC! Please submit code contributions as [pull requests (PRs)](https://github.com/BlauGroup/RNMC/pulls). Work-in-progress PRs are encouraged; just include "\[WIP\]" in the title of your PR.

If you don't know where to start, you can check out the open [issues](https://github.com/BlauGroup/RNMC/issues) or reach out to [Sam Blau](mailto:[email protected]) and describe what ideas you may have in mind.

Have a problem installing or running RNMC, or have an idea for how the code could be better? Please open a new issue, and label the issue (with *e.g.*, “bug”, “enhancement”, or “question”) so that we can triage appropriately.

A more complete guide to contributing can be found in our [online documentation](https://blaugroup.github.io/RNMC/Contributors.html).

0 comments on commit b6f7281

Please sign in to comment.