Contributing

Contributions are welcome! Here's how you can help:

Code

For small fixes or incremental improvements simply fork the repo and follow the process below.

Fork the repository and clone your fork.
Start coding!
- Configure clangd LSP by generating compile_commands.json (e.g. bear -- make or compiledb make)
- Implement your feature.
- Check your code works as expected.
- Run the code formatter: clang-format -i $(git ls-files "*.c" "*.h")
- Run the code linter: clang-tidy -p . $(git ls-files "*.c" "*.h"). Some checks are pretty pedantic, feel free to ignore or debate some of the rules.
- If you prefer, you can run make pre-commit to run several code style checks like the avobe along a few extra stuff.
Commit your changes to a new branch (not master, one change per branch) and push it:
- Commit messages should:
  - Header line: explain the commit in one line (use the imperative) ("feat" for features, "fix", "style", "chore", "docs", etc)
  - Be descriptive.
  - Don't make the title too long and add commit descriptions if you think the changes need it.
  - e.g. "feat: add support for X", "fix(config): config parser segfaulting", "docs(typo): fix a typo in README.md"
Once you are happy with your changes, submit a pull request.
- Open the pull request.
- Add a short description explaining what you've done (or if it's a work-in-progress - what you need to do)

Do a quick search on GitHub to check if the issue has already been reported.
Open an issue and describe the issue you are having - you could include:
- Screenshots.
- Ways to reproduce the issue.
- Your lidm version.
- Your platform (e.g. arch linux or Ubuntu 15.04 x64) and init system if you know.

After reporting you should aim to answer questions or clarifications as this helps pinpoint the cause of the issue.

If you are unsure what category your contribution falls under, feel free to open an issue or a discussion to talk about it.