Skip to content

Pull Request Requirements

Jump to bottom
retrooper edited this page Jun 5, 2026 · 14 revisions

Thank you for your interest in submitting a GitHub Pull Request (PR) to the PacketEvents project. We welcome pull requests. There are a few guidelines you must follow for your PR to be considered for acceptance.

Guidelines

  • Propose your changes in a GitHub issue before working on your PR. This allows us to tell you beforehand if we are even willing to merge such a change and also allows us to give you advice.
  • Have a short, but clear title (and description) explaining what your PR will do.
  • Test your changes. Make sure they actually work and if possible, show us debugs or reports to prove your code works. (Might not be necessary for minor patches)
  • Make sure tab spaces are used (4 spaces) and not 2 or anything else.
  • Make sure every file you create has our license notice at the very top. (if you've taken code from elsewhere, this gets a bit complicated, and in that case just ask me about it)
  • Keep the use of artificial intelligence (including large language models) for code generation to an absolute minimum. If possible, avoid using AI due to potential complications regarding authorship and copyright. If AI was used during the development of a PR, disclose its exact use, including the nature of its use, the tool and model, and the prompt, where relevant. We believe that there are acceptable uses of AI for PacketEvents PRs, such as testing or identifying bugs within the PacketEvents codebase. However, please note that submissions may be rejected if AI use raises concerns.
/*
 * This file is part of packetevents - https://github.com/retrooper/packetevents
 * Copyright (C) 2026 retrooper and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

Welcome to our Wiki

To learn more about PacketEvents, check out our detailed guide.

Clone this wiki locally