CONTRIBUTING.md

Pymine-Net-Net

Contributing

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

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_net/* 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