CONTRIBUTING.adoc

Contributing to Timefold Quickstarts

This is an open source project, and you are more than welcome to contribute!

• Found an issue? Submit an issue.

• Want to fix an issue or contribute an improvement? Talk to us about your ideas or just start coding:

  1. Fork it.

  2. Create a feature branch: git checkout -b feature

  3. Commit your changes with a comment: git commit -m "feat: add shiny new feature" (See Commit messages for details.)

  4. Push to the branch to GitHub: git push origin feature

  5. Create a new Pull Request.

The CI checks against your PR to ensure that it doesn’t introduce errors. If the CI identifies a potential problem, our friendly PR maintainers will help you resolve it.

Developing Python quickstarts

The Python quickstarts on the development branch uses the development 999-dev0 build of timefold-solver. This needs to be built locally:

1. Clone timefold-solver-python.

2. Install build

   $ pip install build

3. Build the main branch of timefold-solver-python

   $ python -m build

4. Reference the timefold-solver-python build directory in your ~/.config/pip/pip.conf:

   [global]
   find-links =
       /path/to/timefold-solver-python/dist