edamontology / edamontology

EDAM is a domain ontology of data analysis and data management in bio- and other sciences, and science-based applications. It comprises concepts related to analysis, modelling, optimisation, and data life cycle. Targetting usability by diverse users, EDAM's structure is relatively simple, divided into 4 sections: Topic, Operation, Data, and Format.
https://edamontology.org
Creative Commons Attribution Share Alike 4.0 International
119 stars 58 forks source link

EDAM contribution guide document, for contributions with and without Github #681

Open Lady-Precious opened 3 years ago

Lady-Precious commented 3 years ago

Seeing how difficult it was for some of us to contribute to the EDAM ontology project especially without Github, there is need for a single document that would show steps on how to contribute with and without Github. This document would include the steps and all the necessary URLs (e.g links to the readme, contribution.md, EDAM browser, etc) so a contributor wouldn’t have to get confused navigating from page to page looking for certain URLs.

matuskalas commented 3 years ago

This is an extremely valuable point @Lady-Precious, thank you🙏🏽 My idea has been that CONTIBUTING.md is exactly that kind of document, accessibly explaining all the options. But obviously it's not good enough. Do you have some ideas how to improve it? That would be super highly appreciated!🙇🏽‍♂️

Lady-Precious commented 3 years ago

Hi Matus, I created this document that has a step-by-step approach on how to contribute to the EDAM Ontology project with or without Github. I believe it would make contributions a lot easier, here is the link to the document. https://docs.google.com/document/d/1py6fzhm-spF2PqX0gxxxEl2AWaNvKABHA_uQCt4hplA/edit?usp=sharing

On Mon, May 3, 2021 at 1:22 AM Matúš Kalaš @.***> wrote:

This is an extremely valuable point @Lady-Precious https://github.com/Lady-Precious, thank you🙏🏽 My idea has been that CONTIBUTING.md is exactly that kind of document, accessibly explaining all the options. But obviously it's not good enough. Do you have some ideas how to improve it? That would be super highly appreciated!🙇🏽‍♂️

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/edamontology/edamontology/issues/681#issuecomment-830960588, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANJXQW5OLWOYRXSBLEE2M33TLXUGHANCNFSM4373TMAQ .

matuskalas commented 3 years ago

Thank you, I'll check it out🙏🏽

And million thanks for your notes on BioPortal @Lady-Precious, I agree with all of them, we should definitely add them asap👍🏽

(Completely optional: In case you would feel like and would have time, sooner or later, we could help you adding them into the OWL file, using Git then (if not locally on your device, then possibly online using Gitpod or another such service). But no problem if not, someone else will gladly implement it. Many thanks again for these contributions and please feel free to add more.🚀 Highly appreciated🙌🏽)

Lady-Precious commented 3 years ago

Now that I have understood the EDAM Ontology project I would definitely make more contributions where necessary, and yes I do feel like and have the time but I do not know how to access the owl file format on my device. I'd appreciate any resources to learn that, and probably add it to the contribution document in case another contributor has the same challenge.

On Mon, May 3, 2021 at 1:40 AM Matúš Kalaš @.***> wrote:

Thank you, I'll check it out🙏🏽

And million thanks for your notes on BioPortal @Lady-Precious https://github.com/Lady-Precious, I agree with all of them, we should definitely add them asap👍🏽

(Completely optional: In case you would feel like and would have time, sooner or later, we could help you adding them into the OWL file, using Git then (if not locally on your device, then possibly online using Gitpod or another such service). But no problem if not, someone else will gladly implement it. Many thanks again for these contributions and please feel free to add more.🚀 Highly appreciated🙌🏽)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/edamontology/edamontology/issues/681#issuecomment-830971768, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANJXQW2IPTMOPLKWRBGY4EDTLXWH3ANCNFSM4373TMAQ .

AnkitaxPriya commented 3 years ago

@matuskalas and @Lady-Precious I'd be glad to contribute my part to this issue. I can help with the required additions into the OWL file using Git.

AnkitaxPriya commented 3 years ago

@Lady-Precious I observed that you have mentioned really clean documentations of contributons using Git and GitHub for the future and fellow contributors. All the resources have been so accurately mentioned that be it a beginner or an advanced user of Git, he/she may contribute to EDAM Ontology very smoothly.

But I did find a deficiency. @matuskalas I think we must update the documentation of contributions using Gitpod in the CONTRIBUTING.md, as I found that a user can switfly contribute to the EDAM Ontology using Gitpod.

Jannathfatima commented 3 years ago

@Lady-Precious Congratulations on your great effort and swiftly explained document.

I would like to add in the section for non Git users who are contributing on webprotege .

we can choose different stages of learning from basic to advance and create those comments thread in order to make the contributors move from basic to advance level of information.

In this manner the contributor will understand where to add his contribution.

Lukong123 commented 3 years ago

Hello @Lady-Precious really nice initiative, Concerning contributing using git that is related to issue #616 well we all had our own experience while accomplishing this task so maybe the instructions could be revised while taking into consideration the comments made under it because from there we have the different ways of troubleshooting the difficulties we encountered.

Uttam-Singhh commented 3 years ago

Really appreciable work @Lady-Precious.🙌🏽 I think the UI and UX of the projects matter the most. If the project's UI & UX is good then people will visit it again. I have worked on the Edam website under @matuskalas but hope to improve it more and as said by @matuskalas we are going the change the look of the website soon. Regarding Contribution using Github as @AnkitaxPriya described that @Lady-Precious had done an amazing job on it and yes it is very helpful for new contributers. And I also think that there is no need to learn advanced Git and GitHub to contribute to the project. The basics of it will be sufficient. but if required(advanced) one can learn it on their own since it will be easy to learn if their basics are clear.

rioualen commented 1 month ago

Hi, Thank you all for the useful comments, and sorry for the delay in replying. As mentioned already, @matuskalas has been updating information on the CONTRIBUTE.md document, and I'm thinking of giving the Read the Docs pages a good makeover soon! 🙌🏻