Contributing guidelines

Forum for technical discussions regarding development. If you have a general suggestion, problem or comment, please use one of the other forums.

Moderator: OpenTTD Developers

Post Reply
User avatar
planetmaker
OpenTTD Developer
OpenTTD Developer
Posts: 9311
Joined: 07 Nov 2007 22:44
Location: Sol d

Contributing guidelines

Post by planetmaker » 10 Mar 2012 09:43

Want to help with OpenTTD development? Join us on GitHub, it's our primary place for patches, pull requests and issues:
https://github.com/OpenTTD/OpenTTD/issues

It's probably a good idea to get in touch and asking on IRC about the status of the tasks listed there / the one you're interested in.

Coding Style can be found at http://wiki.openttd.org/Coding_style. Got questions on those? Ask in the corresponding thread here


There are a few less-maintained places in the wiki:
For people interested in helping OpenTTD's development we created a small todo list of wanted features and patches which require no in-depth knowledge of OpenTTD's source code.

User avatar
Lord Aro
Tycoon
Tycoon
Posts: 2366
Joined: 25 Jun 2009 16:42
Location: Location, Location
Contact:

Re: Wanted contributions / patches

Post by Lord Aro » 10 Mar 2012 10:25

I shall claim the readme/textfile viewers, since i have 'experience' there.. :)
AroAI - A really feeble attempt at an AI

It is practically impossible to teach good programming to students that have had a prior exposure to BASIC: as potential programmers they are mentally mutilated beyond hope of regeneration. --Edsger Dijkstra

User avatar
Zuu
OpenTTD Developer
OpenTTD Developer
Posts: 4553
Joined: 09 Jun 2003 18:21
Location: /home/sweden

Re: Wanted contributions / patches

Post by Zuu » 17 Mar 2012 09:29

I like that you have composed a list like that. That will give some guidance on things to work on for people wanting to contribute patches to OpenTTD.

Note that anyone wanting to add a text filter to saveload or to the server list will need to add a button that opens a query window to set the filter string, unless they first make a patch that allows more than one text edit control per window.
My OpenTTD contributions (AIs, Game Scripts, patches, OpenTTD Auto Updater, and some sprites)
Junctioneer (a traffic intersection simulator)

frosch
OpenTTD Developer
OpenTTD Developer
Posts: 979
Joined: 20 Dec 2006 13:31
Location: Aschaffenburg

Re: Wanted contributions / patches

Post by frosch » 17 Mar 2012 12:19

Ok, the "save window" part of that task went to "hard tasks" :)
⢇⡸⢸⠢⡇⡇⢎⡁⢎⡱⢸⡱⢸⣭⠀⢸⢜⢸⢸⣀⢸⣀⢸⣭⢸⡱⠀⢰⠭⡆⣫⠰⣉⢸⢸⠀⢰⠭⡆⡯⡆⢹⠁⠀⢐⠰⡁

frosch
OpenTTD Developer
OpenTTD Developer
Posts: 979
Joined: 20 Dec 2006 13:31
Location: Aschaffenburg

Re: Wanted contributions / patches

Post by frosch » 25 May 2012 14:53

Small update: We made the descriptions of the tasks more verbose - hopefully :)
⢇⡸⢸⠢⡇⡇⢎⡁⢎⡱⢸⡱⢸⣭⠀⢸⢜⢸⢸⣀⢸⣀⢸⣭⢸⡱⠀⢰⠭⡆⣫⠰⣉⢸⢸⠀⢰⠭⡆⡯⡆⢹⠁⠀⢐⠰⡁

jackdw
Engineer
Engineer
Posts: 3
Joined: 01 Aug 2017 04:32

Re: Wanted contributions / patches

Post by jackdw » 01 Aug 2017 04:35

It looks like the list hasn't been updated in quite a while.

Is it current?

Alberth
OpenTTD Developer
OpenTTD Developer
Posts: 4741
Joined: 09 Sep 2007 05:03
Location: home

Re: Wanted contributions / patches

Post by Alberth » 01 Aug 2017 09:55

jackdw wrote:It looks like the list hasn't been updated in quite a while.
Last change (before I added a new suggestion) was March 2017, so people do seem to change it every now and then.

Nonetheless, likely it generally pays to check in-game of the current status, as well as on the bugrtracker to check if someone has submitted a fix already.
Being a OpenTTD developer does not mean I know what I am doing.
Also, other OpenTTD developers may have different opinions.


User avatar
andythenorth
Tycoon
Tycoon
Posts: 5007
Joined: 31 Mar 2007 14:23
Location: Lost in Music

Re: Contributing guidelines

Post by andythenorth » 25 Oct 2019 08:03

Docs innit :twisted:

TL;DR

Updated https://wiki.openttd.org/Development

Longer

We had quite a lot of development docs spread across the git repo and the official wiki.

Some of these were hard to find, or outdated, or needed formatting updated.

In the wiki, I've
  • removed a lot of empty 'to-do' pages, articles that were duplicated, or entirely outdated
  • applied one template to all the remaining developer docs I could find
  • updated the development page template so that it links wiki docs, and external sources of docs
  • cleaned up page formatting, updated links, clarified information
  • simplified the 'Development' page, and made it an entry point for both core OpenTTD and content APIs

In the git repo docs, I've:
  • converted most files to markdown format
  • split compiling info away from the readme
  • updated the contributing guide
  • provided links to https://wiki.openttd.org/Development so docs can be found
Development docs will continue to be split over multiple locations, as OpenTTD has multiple APIs (newgrf, nogo, noai etc) and other concerns to address (like debugging multiplayer).

I did consider whether development docs could be moved to a single canonical source, but it's not really viable:
  • some stuff needs to stay in the repo with the code, and be updated as part of a PR when code changes
  • some stuff needs to be easily updated without having to go through commit-review-release cycle that applies to the codebase, for which the wiki is better
  • content APIs need to be (and are) documented separately from core OpenTTD
That will be all for now. Please contain further excitement until the next episode. :twisted:

User avatar
PikkaBird
Graphics Moderator
Graphics Moderator
Posts: 5399
Joined: 13 Sep 2004 13:21
Location: The Moon
Contact:

Re: Contributing guidelines

Post by PikkaBird » 25 Oct 2019 09:54

andythenorth wrote:
25 Oct 2019 08:03
That will be all for now. Please contain further excitement until the next episode. :twisted:
Cor.


Post Reply

Return to “OpenTTD Development”

Who is online

Users browsing this forum: No registered users and 3 guests