search

Santiso-Group / despasito

DESPASITO: Determining Equilibrium State and Parametrization Application for SAFT, Intended for Thermodynamic Output
https://despasito.readthedocs.io
BSD 3-Clause "New" or "Revised" License
14 stars 9 forks source link

[General] Add contributing guidelines #37

Open JacksonBurns opened 2 weeks ago

JacksonBurns commented 2 weeks ago

Describe the issue The README welcomes contributions, but some more explicit directions can be helpful to new users.

Expected behavior Consider the official GitHub guidelines for writing these guidelines: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Additional context This issue is part of an ongoing JOSS review at https://github.com/openjournals/joss-reviews/issues/7365

JacksonBurns commented 2 weeks ago

I see actually that you have some guidelines here: https://github.com/Santiso-Group/despasito/tree/master/devtools#how-to-contribute-changes

Maybe just link to this document in the README, and expand it?

jaclark5 commented 1 week ago

@JacksonBurns this was addressed in #39, let me know what you think! Sorry I accidentally committed these changes to another PR.

jaclark5 commented 1 week ago

Changed for these comments have been moved to #40

JacksonBurns commented 5 days ago

I left a small comment about a typo but it looks good to me otherwise!

JacksonBurns commented 5 days ago

Feel free to close after merging that PR