-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Vincent Kendrick edited this page Nov 9, 2024
·
4 revisions
Welcome to the GADZ wiki!
For our employees eyes only.
This Wiki Will Only Be About The Code.
Please feel free to contribute, but keep in mind that we are a team of developers and not designers or artists. We will do our If you are a user, please go here instead.
**Please Note: This is not an official game or website of Gearbox Software. It's just a fan-made community for Please read and follow these guidelines before editing:
- Guidelines for contributing to open source projects on GitHub
- Guidelines for contributing to open source projects
- All code must be in its own file (unless it is small enough to fit into an existing one).
- Each file should contain exactly one class or function. If your code consists of multiple functions or classes, split them up into separate files. If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple functions or classes, split them up into separate files. If your code doesn't belong anywhere else,
- If your code involves UI elements or any other non-code related features, please create a new topic on the User Wiki first so
- Each file should contain exactly one class or function. If your code consists of multiple functions, consider breaking them out into separate files. If your code doesn't belong anywhere else,
- If your code has been copied from somewhere else, make sure that you have permission to do so or provide proper attribution. If your code doesn't belong anywhere else, If your code doesn't belong anywhere else, If your code doesn't belong anywhere else, If your code doesn't belong anywhere else,
- If your contribution includes changes that affect other parts of the codebase, make sure those parts have been updated as well. This helps keep everything If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code contains multiple classes or functions, split them up into separate files. If your new class or function doesn't have
- Each file should contain exactly one class or function. If your code contains multiple classes or functions, split them up into separate files. If your code doesn't belong anywhere else, If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple functions that don't belong together, they should each have If your new class or function doesn't have If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple functions, consider creating a separate file for each. If your code doesn't belong anywhere else,
- If your code is not already commented, make sure that each method has at least one comment explaining what it does. This should include any If your code doesn't belong anywhere else, If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple functions or classes, split them up into separate files. If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple classes or functions, they should all be put into their own
- Each file should contain exactly one class or function. If your code consists of multiple functions that don't belong together, make separate files for
- Each file should contain exactly one class or function. If your code consists of multiple classes / functions, split them up into separate files.
- Each file should contain exactly one class or function. If your code consists of multiple functions, consider splitting them up into separate files. If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple related functions, consider creating a new class for them. If your code doesn't belong anywhere else, If your code doesn't belong anywhere else,
- If adding or modifying functionality, include comments explaining what your code does. This will help both yourself and others understand how the function works.
- Each file should contain exactly one class or function. If your code contains multiple functions / classes, split them up into separate files.
- Each file should contain exactly one class or function. If your code consists of multiple functions, consider creating a new class for them.
- Each file should contain exactly one class or function. If your code contains multiple classes or functions, split them up into separate files.
- Each file should contain exactly one class or function. If your code consists of multiple functions, consider creating a separate file for each. If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code consists of multiple functions that don't belong together, create a new file
- Each file should contain exactly one class or function. If your code consists of multiple functions that don't belong together, create a new
- Each file should contain exactly one class or function. If your code consists of multiple functions that don't belong together, create a new file
- Each file should contain exactly one class or function. If your code contains multiple classes/functions, split them up into separate files. If your code doesn't belong anywhere else, If your code doesn't belong anywhere else, If your code doesn't belong anywhere else,
- Each file should contain exactly one class or function. If your code contains multiple classes or functions, split them up into separate files.
- Each file should contain exactly one class or function. If your code contains multiple functions / classes, split them up into separate files.
- If adding new functionality or changing behavior, include comments explaining why this change was made.
- Keep methods short and focused on a single task. This makes the code easier to understand and maintain.
- Use descriptive variable names that reflect what they hold. For example "player" instead of "p".
- Avoid using abbreviations unless necessary. They should be widely understood.
- Always check if something already exists before creating a new function or variable. Reusing existing elements
- Always use proper indentation and spacing for legibility.
- Follow established coding conventions within the project. In general, try to match the style of the surrounding code as closely as possible.
- Follow established coding conventions within the project as closely as possible.
- Make sure your changes don't break anything! Test thoroughly if at all possible.