|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you so much for your interest in contributing to LMQL, we are very happy to have you here! We |
| 4 | +actively encourage any form of contribution, and are convinced that LMQL should be a community-driven |
| 5 | +project. |
| 6 | + |
| 7 | +## Pull Request Process |
| 8 | + |
| 9 | +1. **Reach Out** If you are planning to implement a new feature (not just a bugfix), please open an issue first or come and talk to the team in our [community Discord](https://discord.gg/7eJP4fcyNT) (#dev channel). In general we are very open to new and |
| 10 | + experimental ideas, but we want to make sure that the feature is in line with the overall goals of the project and that it is not already being worked on. |
| 11 | +2. **Test Well** Please make sure that your code is well-tested. For this also see the 'Testing' section below. |
| 12 | +3. **Import Defensively** Please make sure your code uses defensive imports, i.e. imports that do not fail if a dependency is not installed. For example, if you are using the `transformers` library, you should use `try/except` blocks to catch the `ModuleNotFoundError` that is raised if the library is not installed. This is important because we want to make sure that LMQL can be installed without all dependencies, and that the user is only required to install the dependencies that are actually needed for their use case. |
| 13 | +4. **Document Your Changes** If your contributions or feature requires new forms of configuration or syntax, please make sure to also provide a documentation chapter for it. You can find the MarkDown-based documentation in the `docs/` directory. A script for building and previewing the documentation is provided in `scripts/serve-all.py` (also serves the website and browser playground). |
| 14 | + |
| 15 | +## Testing |
| 16 | + |
| 17 | +**General Testing** For general testing, please make sure that your code is compatible with multiple backends, e.g. if possible try to test with `transformers` models, OpenAI models and `llama.cpp`. LMQL is designed as a vendor-agnostic language, which means all features should be available across all backends. If you do not have the hardware to test changes with multiple backends, please make sure to ask a team member to run the tests for you, before merging your pull request. |
| 18 | + |
| 19 | +**Dependency Changes/Updates** After adding new dependencies, `scripts/flake.d/poetry.lock` needs to be updated. This can be done by running `(cd scripts/flake.d && exec poetry lock --no-update)` (if you run Nix, `nix develop .#minimal` will put you in a shell with the `poetry` command available, even if the `poetry.lock`, `pyproject.cfg`, and other related files are currently broken). If you are able, please also check that the Nix build works after making dependency changes; if you're not in a position to do this, please feel encouraged to request a hand on Discord. |
| 20 | + |
| 21 | +**Running Test Suites** The repository contains a number of test suites in the `src/lmql/tests/` directory. To run all |
| 22 | +tests simply run `python src/lmql/tests/all.py`. Note that for some tests you need to configure an |
| 23 | +OpenAI API key according to the instructions in [documentation](https://lmql.ai/docs/models/openai.html). |
| 24 | +We are working to remove the external dependency on the OpenAI API, but for now it is still required |
| 25 | +for some tests. If you cannot get an API key, you can ask one of the core maintainers to run the |
| 26 | +tests for your, once your pull request is ready. |
| 27 | + |
| 28 | +**Adding Tests** You are also invited to add new tests in the form of a new `test_*.py` file in the `src/lmql/tests/` |
| 29 | +directory. For an example of how to write tests, please see the e.g. `https://github.com/eth-sri/lmql/blob/main/src/lmql/tests/test_functions.py`. |
| 30 | +As demonstrated by this file, also try to implement your tests using `lmql.model("random", seed=<SEED>)` to make sure |
| 31 | +your test code can be run without actually using an LLM or external API, and that it can be re-run |
| 32 | +deterministically. |
| 33 | + |
| 34 | +**[Optional] Web Build Testing:** If you are working on a feature that is available in the web playground of LMQL (e.g. also works with API-based (OpenAI) models only), you can also test the web build with `scripts/serve-all.py`, by typing `bb` for browser build into the script's prompt. This will build and serve the WebAssembly/Pyodide version of LMQL on `http://localhost:8081/playground/`. Please see `scripts/deploy-web.sh` for the build process and requirements of the web playground, which may require you to install additional dependencies. |
| 35 | + |
| 36 | +## Licensing |
| 37 | + |
| 38 | +By contributing to LMQL you agree to license your contributions under the terms of |
| 39 | +the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) as included in the [LICENSE](./LICENSE) file. |
| 40 | + |
| 41 | +## Code of Conduct |
| 42 | + |
| 43 | +### Our Pledge |
| 44 | + |
| 45 | +In the interest of fostering an open and welcoming environment, we as |
| 46 | +contributors and maintainers pledge to making participation in our project and |
| 47 | +our community a harassment-free experience for everyone, regardless of age, body |
| 48 | +size, disability, ethnicity, gender identity and expression, level of experience, |
| 49 | +nationality, personal appearance, race, religion, or sexual identity and |
| 50 | +orientation. |
| 51 | + |
| 52 | +### Our Standards |
| 53 | + |
| 54 | +Examples of behavior that contributes to creating a positive environment |
| 55 | +include: |
| 56 | + |
| 57 | +* Using welcoming and inclusive language |
| 58 | +* Being respectful of differing viewpoints and experiences |
| 59 | +* Gracefully accepting constructive criticism |
| 60 | +* Focusing on what is best for the community |
| 61 | +* Showing empathy towards other community members |
| 62 | + |
| 63 | +Examples of unacceptable behavior by participants include: |
| 64 | + |
| 65 | +* The use of sexualized language or imagery and unwelcome sexual attention or |
| 66 | +advances |
| 67 | +* Trolling, insulting/derogatory comments, and personal or political attacks |
| 68 | +* Public or private harassment |
| 69 | +* Publishing others' private information, such as a physical or electronic |
| 70 | + address, without explicit permission |
| 71 | +* Other conduct which could reasonably be considered inappropriate in a |
| 72 | + professional setting |
| 73 | + |
| 74 | +### Our Responsibilities |
| 75 | + |
| 76 | +Project maintainers are responsible for clarifying the standards of acceptable |
| 77 | +behavior and are expected to take appropriate and fair corrective action in |
| 78 | +response to any instances of unacceptable behavior. |
| 79 | + |
| 80 | +Project maintainers have the right and responsibility to remove, edit, or |
| 81 | +reject comments, commits, code, wiki edits, issues, and other contributions |
| 82 | +that are not aligned to this Code of Conduct, or to ban temporarily or |
| 83 | +permanently any contributor for other behaviors that they deem inappropriate, |
| 84 | +threatening, offensive, or harmful. |
| 85 | + |
| 86 | +### Scope |
| 87 | + |
| 88 | +This Code of Conduct applies both within project spaces and in public spaces |
| 89 | +when an individual is representing the project or its community. Examples of |
| 90 | +representing a project or community include using an official project e-mail |
| 91 | +address, posting via an official social media account, or acting as an appointed |
| 92 | +representative at an online or offline event. Representation of a project may be |
| 93 | +further defined and clarified by project maintainers. |
| 94 | + |
| 95 | +### Enforcement |
| 96 | + |
| 97 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be |
| 98 | +reported by contacting the project team at [hello@lmql.ai](mailto:hello@lmql.ai). All |
| 99 | +complaints will be reviewed and investigated and will result in a response that |
| 100 | +is deemed necessary and appropriate to the circumstances. The project team is |
| 101 | +obligated to maintain confidentiality with regard to the reporter of an incident. |
| 102 | +Further details of specific enforcement policies may be posted separately. |
| 103 | + |
| 104 | +Project maintainers who do not follow or enforce the Code of Conduct in good |
| 105 | +faith may face temporary or permanent repercussions as determined by other |
| 106 | +members of the project's leadership. |
| 107 | + |
| 108 | +### Attribution |
| 109 | + |
| 110 | +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, |
| 111 | +available at [http://contributor-covenant.org/version/1/4][version] |
| 112 | + |
| 113 | +[homepage]: http://contributor-covenant.org |
| 114 | +[version]: http://contributor-covenant.org/version/1/4/ |
0 commit comments