Topic: Getting Started as Contributor

chuckw
Avatar
Topic Opener
Joined: 2010-03-15, 16:23 UTC+1.0
Posts: 945
Ranking
One Elder of Players
Location: New York - USA
Posted at: 2010-12-22, 22:49 UTC+1.0

When I first got involved with contributing work for Widelands, it was challenging to get started. You know, setting up a Launchpad account, creating and registering an SSH key pair, setting up Bazaar and the list goes on... These were things I had never done before and the learning curve was immense.

There is some help in fragments of documentation here and there around the website, but I think it would really be beneficial to have ONE place where a new contributor can go to learn how to establish the things needed for him or her to get productive.

To that end, I have created a wiki page GettingStarted. I still have a couple things to add to it, but I would deeply appreciate anyone who would review it from their own experience base and correct/embellish it or tell me where it needs improvement.

We owe it to ourselves to help newcomers get up to speed.

Cheers!


I see little people.

Top Quote
chuckw
Avatar
Topic Opener
Joined: 2010-03-15, 16:23 UTC+1.0
Posts: 945
Ranking
One Elder of Players
Location: New York - USA
Posted at: 2010-12-23, 00:32 UTC+1.0

I should probably let you know that I also plan to attempt to document the conf files, in a separate wiki page, of course. face-smile.png
While I've had some experience with a lot of the graphics-related parameters and commands, I'm sure there are a lot of others I don't know.

On that topic, if you would care to review the section on conf files in the GraphicsDevelopment page, I welcome your input.

I've started to comb through the source for additional documentation on the conf commands and params, but I'm sure the first draft is going to have many holes and errors. If anyone would care to give me any time-saving tips, (I have no idea how to use doxygen.), I would be grateful.


I see little people.

Top Quote
kingcreole

Joined: 2010-12-18, 12:13 UTC+1.0
Posts: 93
Ranking
Likes to be here
Location: germany
Posted at: 2010-12-23, 11:25 UTC+1.0

thank you, it will help a lot! ^^


live is my dancefloor as long as my lag works

Top Quote
chuckw
Avatar
Topic Opener
Joined: 2010-03-15, 16:23 UTC+1.0
Posts: 945
Ranking
One Elder of Players
Location: New York - USA
Posted at: 2011-02-01, 22:01 UTC+1.0

FYI - I have edited the BzrPrimer wiki page to, hopefully, give some safe and effective guidelines for newbies and oldies alike. face-wink.png
I'd appreciate it if one of you "old hands" look it over to give it the old "snicker test". Let me know if any major reworking is needed.

I'd also urge any "new hands" to review it for some possible helpful hints of which you may not be aware.

Thanks!


I see little people.

Top Quote
ixprefect

Joined: 2009-02-27, 14:28 UTC+1.0
Posts: 367
Ranking
Tribe Member
Posted at: 2011-02-02, 11:13 UTC+1.0

This kind of documentation is great. Nice work face-smile.png

I think the BzrPrimer is fine, except that you might want to mention bzr status and bzr diff. It's a good habit to bzr status before committing, to make sure one doesn't forget to bzr add a file, for example.

In GettingStarted, I noticed you say tree is a synonym for trunk in "Some Terms". Are you sure about that? I've never heard or read it used that way.

So except for those nits, I think this is all very good face-smile.png


Top Quote
Nasenbaer
Avatar
Joined: 2009-02-21, 18:17 UTC+1.0
Posts: 826
Ranking
One Elder of Players
Location: Germany
Posted at: 2011-02-02, 11:40 UTC+1.0

Jepp very nice work Cuck! The BzrPrimer page looks much better now! face-smile.png

However for me the "how can I ease my work through a GUI?" section was missing ;)- I just added a small section for qbzr at the bottom. face-smile.png


Top Quote
chuckw
Avatar
Topic Opener
Joined: 2010-03-15, 16:23 UTC+1.0
Posts: 945
Ranking
One Elder of Players
Location: New York - USA
Posted at: 2011-02-02, 14:32 UTC+1.0

ixprefect wrote:

I think the BzrPrimer is fine, except that you might want to mention bzr status and bzr diff. It's a good habit to bzr status before committing, to make sure one doesn't forget to bzr add a file, for example.

Thanks for the suggestions. I'll put those in. As the saying goes, "An ounce of prevention is worth a pound of cure." face-wink.png

In GettingStarted, I noticed you say tree is a synonym for trunk in "Some Terms". Are you sure about that? I've never heard or read it used that way.

Point taken. I haven't found a definitive glossary of software engineering terms that speaks of trees or trunks in the way they we use them in casual reference to checkouts and branches. The closest I have come is the Wikipedia article on Git. I'll take another try at rewording that section.

nasenbaer wrote:

However for me the "how can I ease my work through a GUI?" section was missing ;)- I just added a small section for qbzr at the bottom. face-smile.png

Thanks! That is a good addition. Qbzr is also available for Windows users, as well. And thanks for adding the TOC! face-smile.png

Edited: 2011-02-02, 14:40 UTC+1.0

I see little people.

Top Quote