search

opencog / loving-ai

26 stars 18 forks source link

provide project description, README #48

Open linas opened 6 years ago

linas commented 6 years ago

The project is currently missing a "project description" -- this is a single short sentence at the top of the github page. Can one be provided? its easy to do.

The README is currently just a few sentences. It should be expanded to state:

jmossbridge commented 6 years ago

Thanks Linas!

I'll talk with the team about who/how we'll get this done.

Julia

On 10/30/17 12:12 PM, Linas Vepštas wrote:

The project is currently missing a "project description" -- this is a single short sentence at the top of the github page. Can one be provided? its easy to do.

The README is currently just a few sentences. It should be expanded to state:

  • What this project is, and why (a paragraph)
  • How to run the thing (a paragraph or two)
  • A review of the different files and components - what the parts are, which files the different parts are in.
  • A short description of the current status.
  • A to-do list of future plans, directions strategy, outlook.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/opencog/loving-ai/issues/48, or mute the thread https://github.com/notifications/unsubscribe-auth/AQOtgjEY7Fk3Bp7MXoPJPPJSU2cikWjuks5sxh-ngaJpZM4QLtN1.

--

Julia Mossbridge, MA, PhD Innovation Lab Director, Institute of Noetic Sciences Science Director, FocusAtWill Labs Visiting Scholar, Department of Psychology, Northwestern University Associated Professor, Integral and Transpersonal Psychology, California Institute of Integral Studies

linas commented 6 years ago

I'll talk with the team about who/how we'll get this done.

Cool. My goal is to enable 3rd parties to play with this, try this out, and potentially to contribute to it. I'd like to see it as a viable open-source project, with collaborators outside of our small little circle.

Building a viable open-source project is really really hard -- you have to promote it in public forums, you have to enable those who are interested in it to explore it, leaf through it, run the basic demos. In my experience, about 1 out of 10 or 20 who "leaf through it" (like a library book) come back and contribute something. Of those, maybe 1 in 4 become long-term. repeating regular contributors.

Continuing with the library book example: without a README, its kind-of like a book without a title page or back cover. No table of contents. No index. Not even a binding holding it in place - its just a loose collection of sheets of paper with curious stuff jotted down. Or rather, that is how outsiders perceive it. You really do want a shiny cover with gold embossed letters and glowing reviews and blurbs on it. It matters.

jmossbridge commented 6 years ago

That's our goal too! We are also creating a website for LOVING AI as well...

On 10/30/17 12:47 PM, Linas Vepštas wrote:

I'll talk with the team about who/how we'll get this done.

Cool. My goal is to enable 3rd parties to play with this, try this out, and potentially to contribute to it. I'd like to see it as a viable open-source project, with collaborators outside of our small little circle.

Building a viable open-source project is really really hard -- you have to promote it in public forums, you have to enable those who are interested in it to explore it, leaf through it, run the basic demos. In my experience, about 1 out of 10 or 20 who "leaf through it" (like a library book) come back and contribute something. Of those, maybe 1 in 4 become long-term. repeating regular contributors.

Continuing with the library book example: without a README, its kind-of like a book without a title page or back cover. No table of contents. No index. Not even a binding holding it in place - its just a loose collection of sheets of paper with curious stuff jotted down. Or rather, that is how outsiders perceive it. You really do want a shiny cover with gold embossed letters and glowing reviews and blurbs on it. It matters.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/opencog/loving-ai/issues/48#issuecomment-340562519, or mute the thread https://github.com/notifications/unsubscribe-auth/AQOtgiTS_wUX80omNxkpvsWIHAdpZD2Fks5sxie8gaJpZM4QLtN1.

--

Julia Mossbridge, MA, PhD Innovation Lab Director, Institute of Noetic Sciences Science Director, FocusAtWill Labs Visiting Scholar, Department of Psychology, Northwestern University Associated Professor, Integral and Transpersonal Psychology, California Institute of Integral Studies

98saurabh98 commented 6 years ago

@jmossbridge I want to start contributing to open source. Can I help in preparing the README and documentation for the project?

jmossbridge commented 6 years ago

That would be great. I sent Eddie some raw text for the readme a few months ago but I don’t think he’s had time to insert it. Eddie, can you dig that up?

On May 21, 2018, at 2:44 AM, Saurabh Budhwar notifications@github.com wrote:

@jmossbridge I want to start contributing to open source. Can I help in preparing the readme?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

eddiemonroe commented 6 years ago

Hi @98saurabh98 Saurabh, thanks for your interest in contributing. We are currently all hands on deck working on research experiments coming up in a few weeks. Let's reconnect regarding this after that. Thanks.

98saurabh98 commented 6 years ago

@eddiemonroe @jmossbridge until then can you please suggest me a starting point to start contributing to open source projects relating to Python, C++, Information retrieval, machine learning, deep learning, etc. Since I am just starting, I am a bit overwhelmed. I will appretiate your help.

jmossbridge commented 6 years ago

Hi Saurabh,

Eddie is really busy with the coding team in Hong Kong, and myself with the experiments.

My guess is this is a good place to start:

https://github.com/freeCodeCamp/how-to-contribute-to-open-source

Take care!

Julia

On 5/21/18 6:15 PM, Saurabh Budhwar wrote:

@eddiemonroe https://github.com/eddiemonroe @jmossbridge https://github.com/jmossbridge until then can you please suggest me a starting point to start contributing to open source projects relating to Python, C++, Information retrieval, machine learning, deep learning, etc. Since I am just starting, I am a bit overwhelmed. I will appretiate your help.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/opencog/loving-ai/issues/48#issuecomment-390832004, or mute the thread https://github.com/notifications/unsubscribe-auth/AQOtgnbWnIHfyY21eDbzaOA3WXcpkf00ks5t02aWgaJpZM4QLtN1.

98saurabh98 commented 6 years ago

Thanks

linas commented 6 years ago

Saurabh,

The best thing that you could do would be to go through the bug reports on the opencog/atomspace repo and the opencog/opencog repo, and start fixing bugs. This will force you to learn system internals. After learning about the system, (if might take months or longer - a year) you can tackle ideas on the ideas page https://wiki.opencog.org/w/Ideas

On Mon, May 21, 2018 at 8:15 PM, Saurabh Budhwar notifications@github.com wrote:

@eddiemonroe https://github.com/eddiemonroe @jmossbridge https://github.com/jmossbridge until then can you please suggest me a starting point to start contributing to open source projects relating to Python, C++, Information retrieval, machine learning, deep learning, etc. Since I am just starting, I am a bit overwhelmed. I will appretiate your help.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/opencog/loving-ai/issues/48#issuecomment-390832004, or mute the thread https://github.com/notifications/unsubscribe-auth/AAFwoNU_WcVZ6p0PCDCwGwn9ZSkztzLPks5t02aWgaJpZM4QLtN1 .

-- cassette tapes - analog TV - film cameras - you