Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 5.15 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 5.15 KB
Raw

Contributing

Setting-up

Preferred method - VSCode Dev Container

VSCode dev containers are a great way to containerize not only the necessary requirements but also recommended IDE extensions as well as settings such as pre-commit hooks and linting preferences. Using this will allow you to jump in to the perfect DSPY contribution environment without having to do much. Additionally, you'll be able to contribute through the web browser using Github Codespaces!

To use our dev container:

  1. Download Docker Desktop
  2. Download VSCode
  3. Within VSCode, install the Remote Development extension (ms-vscode-remote.vscode-remote-extensionpack)
  4. Open the VSCode command palette (cmd / ctrl + shift + p)
  5. Select Dev Containers: Rebuild and Reopen in container. A new VSCode window should open up and it should begin setting up your environment. Once it's done, you can open up a new terminal and start running tests or contributing!
    • Be sure the correct VSCode Python Interpreter is selected. Additional instructions are provided in yellow at the end of the dev container build logs. In short, you need to make sure you have the Poetry interpreter selected or else you'll be using an interpreter without access to the necessary Python packages.
  6. To test that your environment is set up correctly, open a new terminal and run the command pytest. You should be able to run all tests and see them pass. Alternatively, you can open up the testing panel, which looks like a beaker, and click the play button to run all of our tests.
  7. After the initial build, you should now be able to leave and re-enter the container any time without needing to rebuild. To do this, open the command palette and select Dev Containers: Reopen in container. This will not rebuild the container if you've done it correctly.

NOTE: If you use this method, your default shell will be the poetry shell which will contain all the necessary requirements in your terminal. You shouldn't need to prefix python commands with poetry as you're already using the correct poetry virtual environment.

Alternative method

To run the tests, you need to first clone the repository.

Then install the package through poetry: Note - You may need to install poetry. You likely will just need to run pip install poetry. See here

After installing poetry, use it to install our development requirements.

poetry install --with dev

Testing

To run the all tests, or a specific test suite, use the following commands:

poetry run pytest
poetry run pytest tests/PATH_TO_TEST_SUITE

If you are changing CI actions, you can use the act tool to test the CI locally.

Example for testing the push action: You may need the --container-architecture linux/amd64 flag if you are on an M1/2 mac.

 act push

Commit Message format

Commit message format must be respected, with the following regex:

This ends up looking like feature(dspy): added new feature or `enh(devcontainer): decreased size of image

^(break|build|ci|docs|feat|fix|perf|refactor|style|test|ops|hotfix|release|maint|init|enh|revert)\([a-z,A-Z,0-9,\-,\_,\/,:]+\)(:)\s{1}([\w\s]+)

Detailed Breakdown ^: Asserts the start of a line. This means the pattern must match from the beginning of the string.

(break|build|ci|docs|feat|fix|perf|refactor|style|test|ops|hotfix|release|maint|init|enh|revert): This is a capture group that matches any one of the listed keywords. These keywords represent various types of commits, such as feat (feature), fix (bug fix), docs (documentation), etc.

( and ): Matches the literal parentheses ( and ). These are escaped with a backslash because parentheses are special characters in regular expressions, used for defining capture groups.

[a-z,A-Z,0-9,-,_,/,:]+: Matches one or more characters inside the square brackets. It includes lowercase and uppercase letters (a-z, A-Z), digits (0-9), and specific special characters (-, _, /, :). The comma (,) here is likely intended as a separator in the explanation but is actually being treated as a literal character to match, which might be a mistake unless the comma is an expected character in this context.

(:): Captures the colon character. This is another literal match, but it's also captured into a group because of the parentheses.

\s{1}: Matches exactly one whitespace character. {1} is technically redundant since the default behavior without specifying a quantity is to match exactly one.

([\w\s]+): This capture group matches one or more word characters (\w, which includes letters, digits, and underscores) or whitespace characters (\s). This part is likely intended to capture the commit message that follows the initial keyword and scope.

Summary Putting it all together, this regex is used to enforce a structured format for commit messages, starting with a keyword indicating the commit type, followed by a scope enclosed in parentheses, a colon, a single space, and then the descriptive message. The scope part allows for various characters, including letters, numbers, and a few special characters, to accommodate different naming conventions.