search

dpalmasan / TRUNAJOD2.0

An easy-to-use library to extract indices from texts.
https://trunajod20.readthedocs.io/en/latest/
MIT License
29 stars 7 forks source link

Complete / expand contribution guidelines #52

Closed apiad closed 3 years ago

apiad commented 3 years ago

Hey :wave: ! This issue is part of the JOSS review (openjournals/joss-reviews#3153) for this project.

First of all, kudos on the project! As a Spanish-speaker NLP researcher myself, I honestly cannot commend you enough regarding the quality and breadth of this work. We need this kind of research in our community and I thank you on behalf of all my colleague researchers as well.

Checking over the CONTRIBUTING guidelines, it seems there are some TBD sections that could be completed, not necessarily in great detail, but at least to a point where they're useful. If you feel there is a section that is unnecessary you can just remove it (e.g., how to create a pull-request is a general Github-level issue that I don't necessarily think your guidelines should spend too much effort in explaining).

My suggestion is to review the CONTRIBUTING guidelines and either add some content in those TBD sections that you consider relevant or reformat the document to remove them, thus making the guidelines complete and welcoming to new contributors. Please let me know if you feel this is a big issue or if you want to further discuss it.

dpalmasan commented 3 years ago

Hello @apiad , thank you for your kind words and also thank you for the detailed review. I totally agree with you with the CONTRIBUTING.md updates. I have already updated the guidelines and provided descriptions on the TBD placeholders. Let me know if I missed anything from your suggestions.

apiad commented 3 years ago

Whoa, so fast! It seems complete now in my opinion.