ioq3/CONTRIBUTING.md

Contributing to The ioquake3 Project

The following is a set of guidelines for contributing to ioquake3 which is hosted in the The ioquake Group on Github. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

I don't want to read this whole thing, I just have a question!!!

How Can I Contribute?

• Reporting Bugs
• Suggesting Enhancements
• Your First Code Contribution
• Pull Requests Additional Notes
• Issue and Pull Request Labels

I don't want to read this whole thing I just have a question!!!

Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.

We have an official message board and a wiki where the community provides helpful advice if you have questions.

• Discourse, the official ioquake message board
• ioquake3 wiki

If you'd prefer to chat live with other users, sysadmins, and developers, we have IRC and Discord, with a bridge between the two:

• IRC: We're on Freenode (irc.freenode.net) in #ioquake3
• Or you can join our Discord via this link With either of these services it might take a while before someone responds to your question, if you can't wait, use the forums

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for ioquake3. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

• Check the latest version The version in our installers is from 2009! Check if you can reproduce the problem in the latest test build of ioquake3.
• Search the wiki and the forum for your questions and problems.
• Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started ioquake3, e.g. which command exactly you used in the terminal, or how you started ioquake3 with a shortcut. When listing steps, don't just say what you did, but explain how you did it. For example, if you started a new map, explain if you used the menu, or a keyboard macro, or a / command in the ioquake3 console, and if so which one?
• Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
• Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
• Explain which behavior you expected to see instead and why.
• Include screenshots which show you following the described steps and clearly demonstrate the problem.
• If you're reporting that ioquake3 crashed, include a crash report with a stack trace from the operating system. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
• If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

• Did the problem start happening recently (e.g. after updating to a new version of ioquake3) or was this always a problem?
• If the problem started happening recently, can you reproduce the problem in an older version of ioquake3? What's the most recent version in which the problem doesn't happen?
• Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
• If the problem is related to working with third party pk3s and mods (e.g. opening and editing files), does the problem happen with baseq3? We need to be able to reproduce the issue with baseq3, usually.

Include details about your configuration and environment:

• Which version of ioquake3 are you using?
• What's the name and version of the OS you're using?
• What graphics card or chipset is in your computer?

Helping others

People have questions, they ask them on our forums, Facebook, Live Chat, and on other services and websites. Answer them if you can, and add them to the Players Guide on the wiki or Sys Admin Guide if the same questions keep coming up. If the answers are already in the one of our guides, copy and paste the answer and then link the people asking questions to those pages if they have more questions.

Donate

Money buys servers, hosting, and time. We can accept donations although we are not yet a 501(c)(3) nonprofit.

Social Media

Throw ioquake3 a Like on Facebook or follow ioquake3 on Twitter. Let other Quake 3 players know about ioquake3, some people are still playing with id's client!

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for ioquake3, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Before Submitting An Enhancement Suggestion

• Check the latest test build you might discover that the enhancement is already available.
• Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on the ioquake3 repository and provide the following information:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
• Describe the current behavior and explain which behavior you expected to see instead and why.
• Include screenshots which help you demonstrate the steps or point out the part of ioquake3 which the suggestion is related to.
• Explain why this enhancement would be useful to most ioquake3 users.
• Specify which version of ioquake3 you're using.
• Specify the name and version of the OS you're using.

Your First Code Contribution

Unsure where to begin contributing to ioquake3?

If you want to read about using ioquake3, the ioquake3 wiki is free and available online.

Local development

ioquake3 can be developed locally. For instructions on how to do this, see the instructions on our wiki for building it on your computer.

Pull Requests

• Fill in the required template
• Do not include issue numbers in the PR title.

Building Official Installers

This is a reminder for how official installers should be built:

• Please include the id patch pk3s in your installer, which are available from http://ioquake3.org/patch-data/ subject to agreement to the id EULA. Your installer shall also ask the user to agree to this EULA (which is in the /web/include directory for your convenience) and subsequently refuse to continue the installation of the patch pk3s and pak0.pk3 if they do not.

• Please don't require pak0.pk3, since not everyone using the engine plans on playing Quake 3 Arena on it. It's fine to (optionally) assist the user in copying the file or tell them how.

• It is fine to just install the binaries without requiring id EULA agreement, providing pak0.pk3 and the patch pk3s are not referred to or included in the installer.

• Please include at least a libSDL2 so/dylib/dll on every platform.

• Please include an OpenAL so/dylib/dll, since every platform should be using it by now.

• Please be prepared to alter your installer on the whim of the maintainers.

• Your installer will be mirrored to an "official" directory, thus making it a done deal.