javalsai/lidm
0
0
Fork 0
mirror of https://github.com/javalsai/lidm.git synced 2025-08-31 18:38:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add guide on project structure and conventions

Browse Source
This commit is contained in:
javalsai
2025-06-22 01:41:32 +02:00
parent 18fb1417f5
commit 52c9c9e03b
2 changed files with 90 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CONTRIBUTING.md
View File

@@ -12,7 +12,7 @@ For small fixes or incremental improvements simply fork the repo and follow the
1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) your fork.
2. Start coding!
2. Start coding! (it might be helpful to read a [quide on the project structure and conventions](structure.md) before this)
* Configure clangd LSP by generating `compile_commands.json` (e.g. `bear -- make` or `compiledb make`)
* Implement your feature.
* Check your code works as expected.