Thanks for your interest in contributing to prompt2model! We appreciate your support and welcome your contributions. Here's a guide to help you get started:
Installing dependencies: Run the following command to install all the dependencies after you have forked the repository.
pip install .[dev]If you're a developer, it's recommended to install pre-commit hooks before starting your development work. These hooks ensure code formatting, linting, and type-checking. To install the pre-commit hooks, run the following command:
pre-commit installAdditionally, it's essential to run tests to verify the functionality of your code. Execute the following command to run the tests:
pytestTo contribute to prompt2model, or if you have any questions, please reach out to us!
- open an issue or submit a PR
- join us on discord
- or reach out to @vijaytarian and @Chenan3_Zhao on Twitter.
If you have admin privileges for the repository, you can create a new release of the prompt2model library. We utilize the hatchling build system, which simplifies the process of making new releases.
To create a new release, follow these steps:
- Create a new version tag on GitHub, adhering to the semantic versioning guidelines.
- Once the tag is created, the continuous integration (CI) system will automatically build and publish the new version to PyPI.
By following these steps, you can effectively make new releases of the library and contribute to its ongoing development.