1.8 KiB
1.8 KiB
Contributing to Laconic Core
Thank you for considering contributing to our project! Here are some guidelines to help you get started.
Development Environment
This project uses dev containers to ensure consistent development environments. To get started:
- Install Docker and VS Code
- Install the Remote - Containers extension
- Clone the repository and open it in VS Code
- Click the green button in the bottom-left corner and select "Reopen in Container"
Protected Files
Some files in this repository are protected and require specific approval before changes can be merged:
.devcontainer/*
- Dev container configuration.vscode/*
- VS Code workspace settingscore configuration files
- Project configuration filescritical application files
- Core functionality
Please discuss any changes to these files with the maintainers before submitting pull requests.
Code Style
This project uses Biome for formatting and linting. The dev container will automatically configure your editor to use the correct settings.
Submitting Changes
- Fork the repository
- Create a new branch for your changes
- Make your changes following the code style guidelines
- Write tests for your changes
- Submit a pull request
Pull Request Process
- Update the README.md with details of changes if applicable
- The version numbers will be updated by maintainers following semantic versioning
- Pull requests require approval from at least one maintainer
- Once approved, maintainers will merge the PR
Questions?
If you have questions, please open an issue or contact the maintainers.