Skip to content

For developers

Eli D edited this page May 4, 2023 · 11 revisions

Documentation for developers.

This page has documentation and guidelines for developers.
All devs (core devs, or otherwise) need to follow the guidelines on this page.
If you don't follow the guidelines, your commit will be rolled back or your pull request will be denied.

Pull Request/Commit Guidelines

Rules

For a pull request to be accepted, you must provide a changelog (use the example below to help if needed). Also a video of the changes if possible (Video is optional).

Changelog:
- Change 1
- Change 2
- Change 3
extra info about your change here if needed, like a description

For a core dev, provide the changelog in the commit description. If you provide a video just post it on youtube and provide the link in the description as well.

Code guidelines

Rules

Make comments, we don't want the code to be confusing.
If there are no comments to explain something new, your pull request or your pull request or commit may be denied depending on who looks at it.

If someone comments to not mess with something, don't mess with it or your pull request or commit will be denied.

If someone pushes before you do and it causes conflict, don't overwrite their changes.
Instead, just copy your changes this way you can both keep your changes.

If the conflict makes it so you cannot copy your changes, discuss this with the person who pushed before you and see what they want to do about it.

Never make changes to a system that already works unless you have a good reason. If you do, the commit will be rolled back/pull request denied. You should probably say why you changed it in the changelog if you do change something for a better chance at the change staying. If performance or speed is the reason it will be denied.

Happy coding!

Clone this wiki locally