search

globalwordnet / gwadoc

documentation for things like relations and parts of speech used by wordnets
https://globalwordnet.github.io/gwadoc/
Creative Commons Attribution 4.0 International
12 stars 6 forks source link

Contributing guide to add relations #37

Closed gconnect closed 4 years ago

gconnect commented 4 years ago

What this PR Does

gconnect commented 4 years ago

For some reasons old commits are showing up on this PR tried fixing it but it kept showing

goodmami commented 4 years ago

For some reasons old commits are showing up on this PR tried fixing it but it kept showing

It could be that you are creating the branch off of the 'master' branch instead of the latest 'gsod'? Also it looks like the .idea directory is included. Did you use git add ., perhaps?

goodmami commented 4 years ago

More specifically, you can use a workflow like this (apologies if this is obvious to you):

If you're using a IDE or GUI that does these, make sure you're not adding whole directories at a time, just add the files that you want to commit.

Rohitesh-Kumar-Jain commented 4 years ago

Hi,

I feel that the contribution guide (Join Us) section should be on the home page of OMW.

I feel that this guide is more of a technical writer's point of view. There are maybe other people who will be interested to join our organization and there can be more teams like the developer's team, design team, infrastructure team, marketing team, the testing team (maybe we need a native lang team as well ?). So I wish to suggest that we should have separate guides for them, all linked to one central guide.

Another thing which I feel is that maybe we may use simpler words. Because the users using OMW might not have good English vocabulary. E.g. maybe we may use something simpler than this "writers to help this project come to fruition" to something simpler like "writer to make a world of better wordnets".

best, Rohitesh

fcbond commented 4 years ago

Hi,

Thanks for the comments Rohitesh.

I think OMW should also have a contributing guide: @Rohitesh-Kumar-Jain, could you raise an issue for OMW, assign it to yourself and create a guide?

I agree that it would be nice to have multiple teams, but for the moment we do not have such a large group, so I think there is no need to split it up.

I agree that it would be good to have the English as simple as possible, although I think the use of domain specific terminology is fine (especially if we can link to the documentation).

On Fri, Oct 2, 2020 at 10:12 PM Rohitesh Kumar Jain < notifications@github.com> wrote:

Hi,

I feel that the contribution guide (Join Us) section should be on the home page of OMW.

I feel that this guide is more of a technical writer's point of view. There are maybe other people who will be interested to join our organization and there can be more teams like the developer's team, design team, infrastructure team, marketing team, the testing team (maybe we need a native lang team as well ?). So I wish to suggest that we should have separate guides for them, all linked to one central guide.

Another thing which I feel is that maybe we may use simpler words. Because the users using OMW might not have good English vocabulary. E.g. maybe we may use something simpler than this "writers to help this project come to fruition" to something simpler like "writer to make a world of better wordnets".

best, Rohitesh

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/globalwordnet/gwadoc/pull/37#issuecomment-702757176, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIPZRWR2TWJA6GTXCON65DSIXNTZANCNFSM4R5IEX2Q .

-- Francis Bond http://www3.ntu.edu.sg/home/fcbond/ Division of Linguistics and Multilingual Studies Nanyang Technological University

Rohitesh-Kumar-Jain commented 4 years ago

Hi,

Yes OMW should have a contribution guide, I will raise an issue for it and assign it to myself. I was thinking that OMW should have a wiki page and maybe a LinkedIn page as well.

fcbond commented 4 years ago

I am not sure of the pros and cons of having an issue template. Can you tell us why you think we need one?

On Sat, Oct 10, 2020 at 2:42 AM Glory Agatevure notifications@github.com wrote:

@gconnect commented on this pull request.

In CONTRIBUTING.rst https://github.com/globalwordnet/gwadoc/pull/37#discussion_r502610836:

+How to Contribute to Gwadoc + +I'm really glad you're reading this, because we need volunteer technical writers to help this project come to fruition. Thank you for taking the time to contribute! + + +The following are guidelines for contributing to Gwadoc <https://globalwordnet.github.io/gwadoc/> which is hosted in the gwadoc on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + + +If you need to reach us, Our major communication channel is Github. Join our mailing list(Link to be provided) + +The documentation primarily uses reStructuredText (RST). This means to get started contributing to the documentation a fair knowledge of Python, RST and some knowledge of linguistics will be required. Here is a quick guide to help you get started with RST <https://docutils.sourceforge.io/docs/user/rst/quickref.html> + + +Creating Issues + +If you want to request for a new feature to be added to the documentation or modification to existing features use the feature request issue template.

I intend to create issue template. Is that okay?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/globalwordnet/gwadoc/pull/37#discussion_r502610836, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIPZRW26MV5UUXX4AJ7MP3SJ5KSHANCNFSM4R5IEX2Q .

-- Francis Bond http://www3.ntu.edu.sg/home/fcbond/ Division of Linguistics and Multilingual Studies Nanyang Technological University

goodmami commented 4 years ago

Issue templates are useful when you want help direct people to give the necessary information in their issues, and also some templates can automatically assign people or labels to the created issues. It's nice when you're getting low-quality issues from people, or when you get so many issues that pre-filtering would help. I would think that the English WordNet could benefit from templates if they expect users to suggest new entries, but even it only has some guidelines in their CONTRIBUTING.md file.

goodmami commented 4 years ago

There are still some things that could be fixed, but I think it's best to merge as is now. Once we're all on the same page for the gsod branch then we can fix the minor issues.