|
# Contributing to Nimcheck
|
|
|
|
Thank you for considering contributing to Nimcheck.
|
|
|
|
## Getting Started
|
|
|
|
1. Ensure you have Nim >= 2.0.0 installed.
|
|
2. Fork and clone the repository.
|
|
3. Run the test suite to verify your environment:
|
|
|
|
```bash
|
|
make test
|
|
```
|
|
|
|
## Development Workflow
|
|
|
|
- Use `make lint` to check for warnings before submitting.
|
|
- Run `make test` to run the full test suite. All tests must pass.
|
|
- Follow the existing code style and conventions.
|
|
|
|
## Adding a New Language
|
|
|
|
See [LESSONS_LEARNED.md](LESSONS_LEARNED.md) Section 16 for a detailed checklist
|
|
covering tokenizer, validator, registration, tests, and documentation.
|
|
|
|
## Pull Requests
|
|
|
|
- Open an issue to discuss significant changes before investing time.
|
|
- Keep PRs focused on a single change.
|
|
- Ensure all tests pass and no warnings are introduced.
|
|
- Update documentation if the public API changes.
|
|
|
|
## Code of Conduct
|
|
|
|
Be respectful. Keep discussions constructive.
|