Skip to content

Conversation

@p-y-t-h-e-c
Copy link

@p-y-t-h-e-c p-y-t-h-e-c commented Oct 14, 2025

Hello,

To address part of the issue #164 resolving local development setup.
I have added both Bash and PowerShell setup scripts.

The purpose of these scripts is to provide a consistent and automated way to create and configure a local development environment. The scripts perform the following steps:

  • Create and activate a virtual environment
  • Check and upgrade pip to the latest version
  • Verify whether pre-commit is installed
  • Install or update pre-commit as needed
  • Create a default .pre-commit-config.yaml file if one does not exist
  • Create a default .markdownlint.json file if one does not exist
  • Install and update all pre-commit hooks listed in .pre-commit-config.yaml

Additionally, a corresponding dev section has been added to the .gitignore file to ensure these configuration files and local environment artifacts are not pushed to the remote repository

@p-y-t-h-e-c p-y-t-h-e-c marked this pull request as draft October 14, 2025 09:04
@p-y-t-h-e-c p-y-t-h-e-c marked this pull request as ready for review October 14, 2025 09:30
@PeteZ238
Copy link

Is it worth adding some docs in contributing on how to use the scripts?

@p-y-t-h-e-c
Copy link
Author

Is it worth adding some docs in contributing on how to use the scripts?

Added now

@pflooky pflooky merged commit 6c04001 into bitol-io:dev Nov 17, 2025
1 of 2 checks passed
@pflooky pflooky added this to the ODCS v3.1.0 milestone Nov 17, 2025
@pflooky pflooky added the enhancement New feature or request label Nov 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants