Contributing guidelines
Moderator: OpenTTD Developers
- planetmaker
- OpenTTD Developer
- Posts: 9432
- Joined: 07 Nov 2007 22:44
- Location: Sol d
Contributing guidelines
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.
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.
OpenTTD: manual | online content | translations | Wanted contributions and patches
#openttdcoop: blog | wiki | public server | DevZone | NewGRF web translator
DevZone - home of the free NewGRFs: OpenSFX | OpenMSX | OpenGFX | Swedish Rails | OpenGFX+ Trains|RV|Industries|Airports|Landscape | NML
Re: Wanted contributions / patches
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
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
Re: Wanted contributions / patches
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.
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)
Junctioneer (a traffic intersection simulator)
Re: Wanted contributions / patches
Ok, the "save window" part of that task went to "hard tasks"
⢇⡸⢸⠢⡇⡇⢎⡁⢎⡱⢸⡱⢸⣭⠀⢸⢜⢸⢸⣀⢸⣀⢸⣭⢸⡱⠀⢰⠭⡆⣫⠰⣉⢸⢸⠀⢰⠭⡆⡯⡆⢹⠁⠀⢐⠰⡁
Re: Wanted contributions / patches
Small update: We made the descriptions of the tasks more verbose - hopefully
⢇⡸⢸⠢⡇⡇⢎⡁⢎⡱⢸⡱⢸⣭⠀⢸⢜⢸⢸⣀⢸⣀⢸⣭⢸⡱⠀⢰⠭⡆⣫⠰⣉⢸⢸⠀⢰⠭⡆⡯⡆⢹⠁⠀⢐⠰⡁
Re: Wanted contributions / patches
It looks like the list hasn't been updated in quite a while.
Is it current?
Is it current?
Re: Wanted contributions / patches
Last change (before I added a new suggestion) was March 2017, so people do seem to change it every now and then.jackdw wrote:It looks like the list hasn't been updated in quite a while.
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 retired OpenTTD developer does not mean I know what I am doing.
- andythenorth
- Tycoon
- Posts: 5664
- Joined: 31 Mar 2007 14:23
- Location: Lost in Music
Re: Wanted contributions / patches
Since we moved development to github, this is a better list
https://github.com/OpenTTD/OpenTTD/issu ... t+issue%22
https://github.com/OpenTTD/OpenTTD/issu ... t+issue%22
FIRS Industry Replacement Set (released) | HEQS Heavy Equipment Set (trucks, industrial trams and more) (finished)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
- andythenorth
- Tycoon
- Posts: 5664
- Joined: 31 Mar 2007 14:23
- Location: Lost in Music
Re: Contributing guidelines
Docs innit
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
In the git repo docs, I've:
I did consider whether development docs could be moved to a single canonical source, but it's not really viable:
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
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
FIRS Industry Replacement Set (released) | HEQS Heavy Equipment Set (trucks, industrial trams and more) (finished)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
Re: Contributing guidelines
Cor.andythenorth wrote: ↑25 Oct 2019 08:03 That will be all for now. Please contain further excitement until the next episode.
- andythenorth
- Tycoon
- Posts: 5664
- Joined: 31 Mar 2007 14:23
- Location: Lost in Music
Re: Contributing guidelines
Wondering if the first post of this thread should link to the official Contributing guide? https://github.com/OpenTTD/OpenTTD/blob ... IBUTING.md
FIRS Industry Replacement Set (released) | HEQS Heavy Equipment Set (trucks, industrial trams and more) (finished)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
Unsinkable Sam (ships) (preview released) | CHIPS Has Improved Players' Stations (finished)
Iron Horse ((trains) (released) | Termite (tracks for Iron Horse) (released) | Busy Bee (game script) (released)
Road Hog (road vehicles and trams) (released)
Who is online
Users browsing this forum: Google [Bot] and 4 guests