Skip to content

Conversation

@Vigir2
Copy link
Contributor

@Vigir2 Vigir2 commented Dec 17, 2025

This small PR adds the file CONTRIBUTING.md. This file contains a complete step-by-step tutorial on how to create and publish a new release of the package.

@Vigir2 Vigir2 requested a review from OliRom December 17, 2025 20:27
@Vigir2 Vigir2 self-assigned this Dec 17, 2025
@Vigir2 Vigir2 added the documentation Improvements or additions to documentation label Dec 17, 2025
Copy link
Contributor

@OliRom OliRom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very clear guide! I approve this PR, but before merging it, I’d like to wait until I release the next version of QDecomp to follow this guide and see if anything is missing.

Comment on lines +38 to +49
### 5. Tests and formatting

Before creating the release, make sure that all **tests** are passing by running
```bash
pytest
```
in the root directory. Also make sure the repository has proper **formatting** by running
```bash
isort .
black -l 100 .
```
from the root directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those tasks are handled by the make file.

Suggested change
### 5. Tests and formatting
Before creating the release, make sure that all **tests** are passing by running
```bash
pytest
```
in the root directory. Also make sure the repository has proper **formatting** by running
```bash
isort .
black -l 100 .
```
from the root directory.
### 5. Tests and formatting
Before creating the release, make sure that all **tests** are passing by running
```bash
make test_cov

in the root directory. Also make sure the repository has proper formatting by running

make format

from the root directory.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code suggesting didn't render well because of the code blocks inside the commit suggestion (```). What I wanted to say is that the bash commands can be replaced with make test_cov to test with coverage and `make format` to run `isort` and `black`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should present both methods and not remove the individual commands, since they are more explicit than the make files about our formatting practices. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants