Community
Where things happen, and the rules that keep them independent.
Logline is pre-release and small: two people, one repository, issues for everything. The contribution rules are stricter than most projects’ because the engine is an independent, SPL-compatible implementation and has to stay that way.
Where things happen
- Repository
The engine's source, docs and history. Apache 2.0.
- Issues
Bugs, the roadmap items and questions. Open one for anything that is not a pull request.
- Discussions
Longer conversations. Discussions may not be enabled yet; the link is here for when they are, and issues work in the meantime.
- This site
The website's own repository, for a wrong word or a broken page.
How to contribute
A summary of the repository’s CONTRIBUTING.md in this site’s words; the full text is what applies. The engineering conventions (Go version, tests, golden files, commit style) are in TODO.md.
- Work on a branch and open a pull request. The owner reviews every one before it is merged.
- Do not use any Splunk software or account for this project, not to build, test, troubleshoot or check anything. Knowing the search language from your day job is fine; running something on an instance to settle a question here is not.
- Expected results come from public documentation and your own reasoning about the fixture data. A difference you find goes into the compatibility matrix as a known deviation.
- Do not copy documentation text into code, comments, docs, tests, commits, issues or pull requests. Write it in your own words and link the page. The names compatibility depends on (commands, options, functions, fields, time modifiers) are fine.
- The corpus's expected results come only from real ClickHouse runs, never edited by hand, reviewed against the documentation.
- No Splunk marks or logos in names, the UI, domains or branding, and nothing that looks like one or suggests endorsement.
- Leave the existing compatibility identifiers alone and ask in an issue before adding another.
- Opening a pull request confirms the work follows these rules. Contributions are licensed under Apache 2.0.
People
- Author
- Scott Blystone, Wimanaconda on GitHub. Owns the repository, reviews every pull request, runs the test host.
- Collaborator
- Mike, MSabacreationslab on GitHub.
Code of conduct
Be respectful. Criticize the work, not the person. No harassment, insults or discrimination of any kind, in issues, pull requests, discussions or anywhere the project is talked about.
Assume good faith. Most disagreements here are about what a search command should return; they are settled by the public documentation and by reasoning over the fixture data, written down in the pull request, not by who argues longest.
Report a problem to the owner through a GitHub issue or the email on their profile. The maintainers may edit or remove comments, close threads, and remove contributors who break these rules.