For those wishing to contribute, welcome and good luck.
Tests in this repository use the built-in unittest library as well as the coverage library.
To run the tests, the following command can be run from the project's root directory: python -m unittest discover -s source/tests -t source/tests
Alternatively, to run the tests with coverage enabled, you can run the following command from the project's root directory: coverage run -m unittest discover -s source/tests/ -t source/tests/. You can then generate a coverage report using coverage report -m.
All business logic and functional code requires unit testing, while display-related code does not.
A good rule of thumb is if the function has multiple references to pyxel in it, it does not require testing.
100% coverage of functional code is required to pass the coverage CI check.
If you create a new function with drawing code, you can add its signature to .coveragerc to exempt it from coverage checks.
Alternatively, you can use the # pragma: no cover comment to do the same thing without modifying the config file.
To contribute to Microcosm, first create a fork of the repository into your own GitHub account. For development, Python 3.10 as well as the requirements defined in dev_requirements.txt are needed.
Please note that all changes should be made on a branch other than main.
When you're satisfied that you have completed an issue, or have made another valuable contribution, put up a pull request for review. You should receive a response in a day or two, and a full review by the weekend at the latest.
Hey, none of us are perfect. So, if you find a bug in the game, add a new issue here. Any submitted issues of this kind should have the bug label, so be sure to mention in the issue description that the label should be applied.
If you're not sure whether something classifies as a bug, just suggest the 'almost a bug' label instead.
Any issue with either of the 'hacktoberfest' or 'good first issue' labels will be a good start.
If you have a dream for Microcosm that isn't adequately captured in existing issues, add a new issue here. If you think the feature may require some significant work, be sure to mention that in the issue description as well.
Microcosm broadly follows PEP-8 styling.
Pylint is also used to guarantee conformity.
If you're ever unsure whether you've formatted something correctly, run pylint $(git ls-files '*.py').
See here for the repository's Code of Conduct.