-
-
Notifications
You must be signed in to change notification settings - Fork 151
Pull Request Requirements
retrooper edited this page May 7, 2024
·
11 revisions
We love to receive your pull requests. You have a chance to contribute your ideas. There are a few things you need to look out for before submitting a PR.
- 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)
/*
* This file is part of packetevents - https://github.com/retrooper/packetevents
* Copyright (C) 2024 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/>.
*/
Examples of how to use PacketEvents
Click this!