-
Notifications
You must be signed in to change notification settings - Fork 0
Release Tutorial #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Release Tutorial #81
Conversation
OliRom
left a comment
There was a problem hiding this 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.
| ### 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. |
There was a problem hiding this comment.
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.
| ### 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 formatfrom the root directory.
There was a problem hiding this comment.
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`.
There was a problem hiding this comment.
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?
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.