### Install Invenio-RDM-Records Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/INSTALL.rst Use this command to install the package from PyPI. Ensure you have pip installed. ```console $ pip install invenio-rdm-records ``` -------------------------------- ### Install Invenio-RDM-Records with all dependencies Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/README.rst Install the package with all optional dependencies. Ensure you have chosen a version of search and database. ```console pipenv run pip install -e .[all] ``` -------------------------------- ### Set up virtual environment and install dependencies Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Create a virtual environment and install the project with all development dependencies. This prepares your local copy for development. ```console mkvirtualenv invenio-rdm-records cd invenio-rdm-records/ pip install -e .[all] ``` -------------------------------- ### Install Invenio Search Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/README.rst Install Invenio Search with a specific version of OpenSearch. ```console pipenv run pip install invenio-search[] ``` -------------------------------- ### Install Invenio Database Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/README.rst Install Invenio Database with a specific database backend (e.g., MySQL or PostgreSQL). ```console pipenv run pip install invenio-db[<[mysql|postgresql|]>] ``` -------------------------------- ### Clone the repository Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Clone your forked repository locally to begin development. ```console git clone git@github.com:your_name_here/invenio-rdm-records.git ``` -------------------------------- ### Run Tests Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/README.rst Execute the test suite for Invenio-RDM-Records. ```console pipenv run ./run-tests.sh ``` -------------------------------- ### Run tests and checks Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Execute the test suite to ensure your changes pass all tests, including code style (PEP8), documentation checks (PEP257), and building documentation. ```console ./run-tests.sh ``` -------------------------------- ### Push branch to GitHub Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Push your local development branch to your forked repository on GitHub to prepare for a pull request. ```console git push origin name-of-your-bugfix-or-feature ``` -------------------------------- ### Commit changes with conventional commit messages Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Stage all changes, commit them with a signed-off-by, and use a structured message format that includes a type (e.g., NEW, FIX, BETTER) and a descriptive title. This helps in generating release notes. ```console git add . git commit -s -m "component: title without verbs" -m "* NEW Adds your new feature." -m "* FIX Fixes an existing issue." -m "* BETTER Improves and existing feature." -m "* Changes something that should not be visible in release notes." ``` -------------------------------- ### Create a new branch for development Source: https://github.com/inveniosoftware/invenio-rdm-records/blob/master/CONTRIBUTING.rst Create a new branch for your bug fixes or new features. This isolates your changes from the main development line. ```console git checkout -b name-of-your-bugfix-or-feature ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.