Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete / expand contribution guidelines #52

Closed
apiad opened this issue Apr 16, 2021 · 2 comments
Closed

Complete / expand contribution guidelines #52

apiad opened this issue Apr 16, 2021 · 2 comments

Comments

@apiad
Copy link
Contributor

apiad commented Apr 16, 2021

Hey 👋 ! 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 pushed a commit that referenced this issue Apr 16, 2021
@dpalmasan
Copy link
Owner

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
Copy link
Contributor Author

apiad commented Apr 16, 2021

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

@apiad apiad closed this as completed Apr 16, 2021
supersonic1999 pushed a commit to supersonic1999/TRUNAJOD2.0 that referenced this issue Apr 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants