Page 1 of 1

Contributing guidelines

Posted: 10 Mar 2012 09:43
by planetmaker
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.

Re: Wanted contributions / patches

Posted: 10 Mar 2012 10:25
by Lord Aro
I shall claim the readme/textfile viewers, since i have 'experience' there.. :)

Re: Wanted contributions / patches

Posted: 17 Mar 2012 09:29
by Zuu
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.

Re: Wanted contributions / patches

Posted: 17 Mar 2012 12:19
by frosch
Ok, the "save window" part of that task went to "hard tasks" :)

Re: Wanted contributions / patches

Posted: 25 May 2012 14:53
by frosch
Small update: We made the descriptions of the tasks more verbose - hopefully :)

Re: Wanted contributions / patches

Posted: 01 Aug 2017 04:35
by jackdw
It looks like the list hasn't been updated in quite a while.

Is it current?

Re: Wanted contributions / patches

Posted: 01 Aug 2017 09:55
by Alberth
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.

Re: Wanted contributions / patches

Posted: 06 Feb 2019 21:33
by andythenorth
Since we moved development to github, this is a better list :)

https://github.com/OpenTTD/OpenTTD/issu ... t+issue%22

Re: Contributing guidelines

Posted: 25 Oct 2019 08:03
by andythenorth
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:

Re: Contributing guidelines

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

Re: Contributing guidelines

Posted: 20 Nov 2019 09:21
by andythenorth
Wondering if the first post of this thread should link to the official Contributing guide? :) https://github.com/OpenTTD/OpenTTD/blob ... IBUTING.md