Welcome Joris!
I would enjoy helping you get started contributing to OpenStack. Are you
on IRC yet? Talking on IRC is our most efficient means of communication.
On the Freenode network I suggest joining #openstack, #openstack-dev,
#openstack-101, #openstack-meeting, #openstack-meeting-alt as well as
#openstack-neutron. My IRC nick is anteaya, please ping me.
To answer your question, documenting code is a great way to get started.
There will be a need to document prior code. This does not remove the
author's responsibility to document code as we move forward - it is a
good habit to get into and ensures that work doesn't get piled onto just
one person, everyone has to document their own patches.
So what we can do is have a chat, I can find out about your areas of
interest and then we can find both some code and the people who wrote it
so that you can talk directly with code authors and have them explain in
their own words what the method/function is supposed to do. Then I can
walk you through submitting your first few patches until you get the
hang of it. Then hopefully you will be able to teach others to do the same.
I can also help you to learn how to review patches to support those
people willing to embrace the docstring ethos so you can really help out
here.
Thanks Joris, I look forward to chatting on irc in #openstack-neutron,
Anita.
On 11/12/2013 03:22 AM, Joris Roovers (jroovers) wrote:
Hi Anita,
Is this an area where a new developer can help out?
I've got a little time to spare (not a whole lot, best-effort...) and would
like to help out. I'm very new to all of this though.
I figure that documenting code is a good way to contribute and learn at the
same time.
Could anyone point me to a simple class that could benefit from this? I'll
probably need some help getting it through the system (never submitted a patch
for Openstack before).
Thanks!
Joris
-----Original Message-----
From: Anita Kuno [mailto:ante...@anteaya.info]
Sent: Tuesday, November 12, 2013 01:50
To: OpenStack Development Mailing List
Subject: [openstack-dev] [Neutron]Good example of dev doc/docstrings in code.
Hello:
I will be creating noise around testing in order to help shore up the gap
between where we are in Neutron and where everybody agrees we would like to be.
To that end I would like to point out a great example of docstrings in code:
https://github.com/openstack/neutron/blob/master/neutron/neutron_plugin_base_v2.py
which is used to generate dev docs.
Here are the generated docs from the above docstrings in the code:
http://docs.openstack.org/developer/neutron/devref/plugin-api.html
The docstrings are great for the author of the patch to ensure the purpose of
each method/function is clearly understood by themselves, reviews and users of
the code.
I would like to encourage current and future patches to include good
docstrings/dev docs going forward.
Thanks everyone for your support helping to close the gap with testing with
Neutron.
Thank you,
Anita Kuno
anteaya
_______________________________________________
OpenStack-dev mailing list
OpenStack-dev@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
_______________________________________________
OpenStack-dev mailing list
OpenStack-dev@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
_______________________________________________
OpenStack-dev mailing list
OpenStack-dev@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
