You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by ro...@apache.org on 2013/01/15 14:54:12 UTC
svn commit: r1433415 -
/openoffice/site/trunk/content/orientation/intro-development.mdtext
Author: robweir
Date: Tue Jan 15 13:54:11 2013
New Revision: 1433415
URL: http://svn.apache.org/viewvc?rev=1433415&view=rev
Log:
CMS commit to openoffice by robweir
Modified:
openoffice/site/trunk/content/orientation/intro-development.mdtext
Modified: openoffice/site/trunk/content/orientation/intro-development.mdtext
URL: http://svn.apache.org/viewvc/openoffice/site/trunk/content/orientation/intro-development.mdtext?rev=1433415&r1=1433414&r2=1433415&view=diff
==============================================================================
--- openoffice/site/trunk/content/orientation/intro-development.mdtext (original)
+++ openoffice/site/trunk/content/orientation/intro-development.mdtext Tue Jan 15 13:54:11 2013
@@ -1,100 +1,109 @@
-Title: (Draft) Introduction to Development
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- .
- http://www.apache.org/licenses/LICENSE-2.0
- .
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-##Introduction
-
-In this orientation module you will learn how to get started with development on OpenOffice.
-
-To complete this module, read through the material on this page, including the linked references. There will also
-be some start-up tasks for you to perform, such as signing up for an account in our defect tracking database.
-
-Your first task is to subscribe to our Development mailing list. You can subscribe by sending an email to
-[dev-subscribe@openoffice.apache.org](mailto:dev-subscribe@openoffice.apache.org).
-
-Then you can introduce yourself by [sending an email to the list](mailto:dev@openoffice.apache.org?subject=New Dev Volunteer).
-We'd love to hear who you are, where you are from, what your background is, etc. Also as you work through the
-items on this page, if you have questions or problems, please feel free to ask for help by sending a note to
-this same list.
-
-Note: In parallel with the Dev-specific items on this page, you may want to first review the [Level 1 and Level 2 Orientation Modules](http://openoffice.apache.org/orientation/index.html)
-as well. They have useful background information on The Apache Way, mailing list etiquette, decision making in the
-project, etc. A quick review is a good idea, especially if you are new to working in Apache-style open source projects.
-
-Now with the introductions out of the way, let's get started!
-
-##OpenOffice Development: Good, the Bad and the Ugly
-
-Let's be honest. The size, age and complexity of the C++ codebase makes coding a challenge. This is not a trivial codebase to learn. But if you like a good challenge then
-you'll like this project. There are tasks suitable for programmers with a range of programming experience, and we have many veteran OpenOffice hackers
-in the project who are happy to answer your questions.
-
-And in its favor, there are few other programs that you can help develop, that have the reach of OpenOffice. Many millions of users, and another million downloads every week,
-dowloaded from every country in the world (except North Korea). So the work you do, the bugs you fix, the features you add, will benefit millions of users around the world.
-
-
-## Building OpenOffice
-
-Building OpenOffice on Linux or Mac is relatively easy, but expect the firt attempt to require some trial and error as you work on the configuration.
-
-Building on Windows is more complicated, due to the need to install more prerequistite tools.
-
-Our [Building Guide](http://wiki.openoffice.org/wiki/Documentation/Building_Guide) on the wiki is your starting point. Follow the instructions there, step by step. Ask questions on
-the dev list if you get stuck. If you get an error it can be useful to search our [mailing list archives](http://markmail.org/search/+list:org.apache.incubator.ooo-dev) to see if it
-is a know problem with a known solution.
-
-Once you have a successful build, [post a note to the dev list](mailto:dev@openoffice.apache.org?subject=Succesful 1st Build!) for some well-earned congratulations!
-
-## Finding Easy Tasks
-
-As a new developer you will want to find some easy coding tasks. These are tasks that generally can be done with good C++ skills, but do not require comprehensive knowledge of how
-OpenOffice is put together. The tasks are more localized. By doing easy tasks you gain experience and confidence hacking with the code base.
-
-We use a [Bugzilla issue tracker](https://issues.apache.org/ooo/) to track reported defects in OpenOffice. Some of us also use Bugzilla for tracking feature and enhancement tasks as well. The value of tracking
-all coding-related tasks in Bugzilla is that it helps our QA volunteer know what areas to test. Whether code was changed to fix a bug or enhance a feature -- the QA impact is pretty
-much the same.
-
-If you have not done so already, please [sign up for a Bugzilla account](https://issues.apache.org/ooo/createaccount.cgi). This will allow you to enter new bugs or tasks, but also
-assign yourself existing ones.
-
-Many tasks are classified in the "difficulty" field". The ones classified as "easy" or "simple" (one level harder than "easy") are good ones to start with. You can find these with the
-[easy-hacks](https://issues.apache.org/ooo/buglist.cgi?cmdtype=runnamed&namedcmd=easy-hacks&list_id=41609) and [simple-tasks](https://issues.apache.org/ooo/buglist.cgi?cmdtype=runnamed&Bugzilla_restrictlogin=on&list_id=41611&namedcmd=simple-hacks) queries.
-
-One you pick a bug and assign it to yourself, you might want to post a note to the dev list, letting us know. We might have some helpful hints to get you started.
-
-
-## Submitting Patches
-
-As you read in the [Introduction to Contributing to OpenOffice module](http://openoffice.apache.org/orientation/intro-contributing.html) contributors who have demonstrated merit via
-their project contributions can be voted in as Committers. Committers are the ability to check code into project's source control. Contributors who are nont (yet) Committers
-must submit their patches and have them be reviewed first.
-
-Please review these [guidelines for submitting patches](http://openoffice.apache.org/svn-basics.html#creating_and_submitting_patches). A good practice is to attach the patch to the
-Bugzilla issue and then send a link to the issue to the Dev list, asking for someone to review and commit the patch.
-
-##Other Useful Resources
-
- * We have an [instance of Altsassian Fisheye](https://fisheye6.atlassian.com/browse/ooo) which can be useful for browsing the code base and understanding dependencies.
- * The [commits mailing list](http://openoffice.apache.org/mailing-lists.html#commits-mailing-list) echos every checkin made to the code base. Developers are encouraged to subscribe so they are aware of other changes, and can help review.
-
-## Module Completion
-
-Once you have completed this module, go to our our [Directory of Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers) wiki page and add or update
-your information. Congratulations! Please send a note to [qa@openoffice.apache.org](mailto:qa@openoffice.apache.org?subject=Completed Introduction to Development)so we know.
-
-
-
+Title: (Draft) Introduction to Development
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+##Introduction
+
+In this orientation module you will learn how to get started programming OpenOffice.
+
+To complete this module, read through the material on this page, including the linked references. There will also
+be some start-up tasks for you to perform, such as signing up for an account in our defect tracking database.
+
+Your first task is to subscribe to our Development mailing list. You can subscribe by sending an email to
+[dev-subscribe@openoffice.apache.org](mailto:dev-subscribe@openoffice.apache.org).
+
+Then you can introduce yourself by [sending an email to the list](mailto:dev@openoffice.apache.org?subject=New Dev Volunteer).
+We'd love to hear who you are, where you are from, what your background is, etc. Also as you work through the
+items on this page, if you have questions or problems, please feel free to ask for help by sending a note to
+this same list.
+
+Note: In parallel with the Dev-specific items on this page, you may want to also review the [Level 1 and Level 2 Orientation Modules](http://openoffice.apache.org/orientation/index.html). They have useful background information on The Apache Way, mailing list etiquette, decision making in the
+project, etc. A quick review is a good idea, especially if you are new to working in Apache-style open source projects.
+
+Now with the introductions out of the way, let's get started!
+
+##OpenOffice Development: Good, the Bad and the Ugly
+
+Let's be honest. The size, age and complexity of OpenOffice's C++ codebase makes coding a challenge. This is not a trivial codebase to learn. But if you like a good challenge then
+you'll love this project! There are tasks suitable for programmers with a range of programming experience, and we have many veteran OpenOffice hackers
+in the project who are happy to answer your questions.
+
+And in its favor, there are few other programs that you can help develop, that have the reach of OpenOffice. Many millions of users depend on OpenOffice,
+with another million downloads every week, downloads from every country in the world (except North Korea). So the work you do, the bugs you fix,
+the features you add, will benefit millions of users around the world.
+
+
+## Building OpenOffice
+
+It all starts by establish a local build environment. Building OpenOffice on Linux or Mac is relatively easy,
+but expect the first attempt to require some trial and error. Every configuration is slightly different.
+
+Building on Windows is more complicated, due to the need to install more prerequisite tools.
+
+Our [Building Guide](http://wiki.openoffice.org/wiki/Documentation/Building_Guide) on the wiki is your starting point. Follow the instructions there, step by step. Ask questions on
+the dev list if you get stuck. If you get an error it can be useful to search our [mailing list archives](http://markmail.org/search/+list:org.apache.incubator.ooo-dev) to see if it
+is a know problem with a known solution.
+
+Note also the the current list of configuration flags used in building the development snapshot builds at the
+bottom of the [development snapshot builds page](https://cwiki.apache.org/confluence/display/OOOUSERS/Development+Snapshot+Builds#DevelopmentSnapshotBuilds-AOO3.4.1).
+Although there are many other combinations of flags you can use, some of which are very useful for development, the flags on that page are what we use in our official releases.
+
+Once you have a successful build, [post a note to the dev list](mailto:dev@openoffice.apache.org?subject=Succesful 1st Build!) for some well-earned congratulations!
+
+## Finding Easy Tasks
+
+As a new developer you will want to find some easy coding tasks. These are tasks that generally can be done with good C++ skills, but do not require comprehensive knowledge of how
+OpenOffice is put together. The tasks are more localized. By doing easy tasks you gain experience and confidence hacking with the code base.
+
+We use a [Bugzilla issue tracker](https://issues.apache.org/ooo/) to track reported defects in OpenOffice. Some of us also use Bugzilla for tracking feature and enhancement tasks as well. The value of tracking
+all coding-related tasks in Bugzilla is that it helps our QA volunteer know which areas to test. Whether code was changed to fix a bug or enhance a feature -- the QA impact is pretty
+much the same.
+
+If you have not done so already, please [sign up for a Bugzilla account](https://issues.apache.org/ooo/createaccount.cgi). This will allow you to enter new bugs or tasks, but also
+assign yourself existing ones.
+
+Many tasks are classified in the "difficulty" field. The ones classified as "easy" or "simple" (one level harder than "easy") are good ones to start with. You can find these with the
+[easy-hacks](https://issues.apache.org/ooo/buglist.cgi?cmdtype=runnamed&namedcmd=easy-hacks&list_id=41609) and [simple-hacks](https://issues.apache.org/ooo/buglist.cgi?cmdtype=runnamed&list_id=41611&namedcmd=simple-hacks) queries.
+
+One you pick a bug and assign it to yourself, you might want to post a note to the dev list, letting us know. We might have some helpful hints to get you started.
+
+
+## Submitting Patches
+
+As you read in the [Introduction to Contributing to OpenOffice module](http://openoffice.apache.org/orientation/intro-contributing.html), contributors who have demonstrated merit via
+their project contributions can be voted in as Committers. Committers have the ability to check code into project's source control. Contributors who are not (yet) Committers
+must submit their patches and have them be reviewed first.
+
+Please review these [guidelines for submitting patches](http://openoffice.apache.org/svn-basics.html#creating_and_submitting_patches). A good practice is to attach the patch to the
+Bugzilla issue and then send a link to the issue to the Dev list, asking for someone to review and commit the patch.
+
+##Other Useful Resources
+
+ * The [OpenOffice.org Developer's Guide](http://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide) has
+a lot of information, some of it up-to-date.
+ * Adfinis Sygroup hosts an [instance of OpenGrok](http://opengrok.adfinis-sygroup.org/source/) for us which is useful
+for understanding the code.
+ * We have an [instance of Altsassian Fisheye](https://fisheye6.atlassian.com/browse/ooo) which can be useful for browsing the code base and understanding dependencies. (This service is currently broken but we hope to have it back soon).
+ * The [commits mailing list](http://openoffice.apache.org/mailing-lists.html#commits-mailing-list) echos every checkin made to the code base. Developers are encouraged to subscribe so they are aware of other changes, and can help review.
+
+## Module Completion
+
+Once you have completed this module, go to our our [Directory of Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers) wiki page and add or update
+your information. Congratulations! Please send a note to [qa@openoffice.apache.org](mailto:qa@openoffice.apache.org?subject=Completed Introduction to Development)so we know.
+
+
+