search

MHKiT-Software / MHKiT-Python

MHKiT-Python provides the marine renewable energy (MRE) community tools for data processing, visualization, quality control, resource assessment, and device performance.
https://mhkit-software.github.io/MHKiT/
BSD 3-Clause "New" or "Revised" License
47 stars 45 forks source link

Update readme #224

Closed castillocesar closed 1 year ago

castillocesar commented 1 year ago

draft of updated readme. still need to update the pull request instructions.

castillocesar commented 1 year ago

updated the README to include some instructions on submitting issues, creating a fork, creating a branch, and submitting a pull request.

ssolson commented 1 year ago

Hey @castillocesar thanks for this submission. Looking at this PR you have added 4 sections to the MHKiT README that cover the basic features of GitHub. I would currently not recommend this PR as written for inclusion into MHKiT. At most I would only include how to create an issue at which point the maintainers could help interested parties lacking version control experience. Further much of this is covered in detail with not only the how but the why in the documentation.

@akeeste and @rpauly18 could you provide your thoughts?

rpauly18 commented 1 year ago

@ssolson I see what you are saying about it being repeated information from the documentation, but I do not think it hurts anything to have it repeated here. Hopefully this will be a reminder to people of how to operate when contributing to MHKiT. If you feel strongly that this should not be included, I won't get upset about that either

akeeste commented 1 year ago

This update was on the project board awhile ago, which is why Cesar was working on it. Most of the information is not repeated on our Online Forum page. I can take this review, and we'll consider whether this is better on the readme or to flush out that linked documentation page.