PyMine

Contributing

Want to help out? This is how! P.S. You get a shiny contributor role in the Discord server too!

Create a bug report, feature request, or other issue, and assign yourself.
Fork the repository, or create a new branch.
Make your changes, with descriptive commit names.
Create a pull request with a detailed description of the issue resolved, link the issue you created, and request a reviewer.
One of the main devs will review it and request changes if needed!
You should probably also join our Discord server, for news on the status and direction of the project

Note: For vanilla server features (as PyMine plans to support all of them), don't create an issue without an attached pull request to add it.

General Guidelines

Formatting is enforced with the black formatter as defined here
Use f-strings (f"{thing}") instead of .format() where possible
Use concatenation instead of f-strings where possible, as concatenation is faster
Use snake_case for variables
Constants should either be loaded from a config file or be in UPPER_SNAKE_CASE
Lines shouldn't be longer than 100 characters.

Imports

Imports should be sorted by size descending
Imports from pymine/* should be separated from the rest of the imports by a newline
The tool isort should do this for you, if installed

Tools

VSCode

@The456gamer Has made a VSCode config to put in .vscode/settings.json here