From WineHQ Wiki
Revision as of 09:21, 11 July 2022 by Julliard (talk | contribs) (Mention Gitlab)
Jump to: navigation, search

If you're interested in contributing code to Wine, getting started can be daunting. Wine is an ambitious project, with a large codebase, a lot of history, and a strong emphasis on code quality. The resources below should give you an idea of how to start making your way through both the source code and the development protocols that have evolved over the years.

Getting Started

References and FAQs

  • The Developer FAQ, and Developer Hints are quick reads and a good place to begin.
  • The Wine Developer's Guide is a very-comprehensive guide and the ultimate reference for working on Wine.
  • Also, all developers should be careful not to violate the Clean Room Guidelines (also see relevant sections of the Developer FAQ). Submitting patches based on disassembled Microsoft code or dumped implementation details is simply not acceptable.

Working with Other Developers

Sometimes the best way to get some help is to talk with other developers. While other contributors are often busy, focused, well-informed discussions and questions are encouraged and should not be ignored.

  • Discussions primarily take place on Wine's mailing lists. The developers' list in particular is the place to discuss changes to the software (be sure to subscribe before emailing a list, or else your mail will probably be filtered out as spam).
  • There are a couple of IRC channels, although depending on timing and urgency, you may not always get a response.
  • You can see what some of the other contributors are working on by reading the Who's Who or Acknowledgements. Some contributors also have personal pages on the wiki.
  • The Wine project has been overseen by Alexandre Julliard for many years now, and as a result, a Wine hacker's informal reputation for writing quality code is known eponymously as a Julliard Rank. Although earning and maintaining this good reputation is key to becoming a successful contributor, the community tries to be helpful and does not expect anyone to be perfect, so don't feel discouraged :-)
  • If you're interested in possibly meeting other programmers in person, WineConf is an annual, offline meeting for Wine developers.
  • If you are a student with an interesting feature or solution to a problem, you might consider applying to work on Wine as part of Google's Summer Of Code too.

Working with the Code

  • Wine currently uses Gitlab to manage all source code, in order to grab your own copy of the code, look at the Git Wine Tutorial. There are also some hints on using Git Branches to manage your work.
  • There is also a short page about browsing the Source Code online and downloading code for other portions of the project.
  • When you're ready to share some of your changes with everyone, be sure to follow the guidelines for Submitting Patches.

Building from Source

You probably want to see the page on Building Wine or Building on MacOSX. You can also look in Category:Distributions to see if your distro has its own page. If so, there might be specifics about the dependencies and build process for your system.

Other Aspects

There are other aspects of the project besides the main program itself, and these can also sometimes use a programmer's touch.

  • For info specifically on testing and bug-hunting, try visiting Debugging Hints and the Bugs page, especially the section "for developers."
  • If you've written a patch and want to test it more before submission, or maybe just display it in action for others to comment, consider using the WineHQ Build Server.
  • Things such as the website and documentation also have moving parts besides content. For more details, see the pages for Designers and Writers.
  • There are some tips for those interested in Packaging Wine for different distros and platforms.
  • Interested in porting the source code of your Windows-native application to Unix? Consider looking into Winelib.

Resources on Specific Topics

There are actually dozens of pages related to specific components and features in Wine. You may find it easier to simply try searching for the topic you're interested in. However, a few categories have been created to make finding things a little quicker.

  • Category:DLLs consists of all pages about a specific component of the Windows API
  • Category:Architecture contains entries about porting Wine to different hardware architectures
  • Category:Compilers contains pages for different compilers that people have attempted building Wine with.