You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Updated README template and fixed links to be consistent for HTML (feast-dev#4423)
* chore: fixed README template to be consistent with current README
Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>
* docs: markdown links consistency with html
Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>
---------
Signed-off-by: dandawg <12484302+dandawg@users.noreply.github.com>
Copy file name to clipboardexpand all lines: .github/pull_request_template.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
<!-- Thanks for sending a pull request! Here are some tips for you:
2
2
3
-
1. Ensure that your code follows our code conventions: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#code-style--linting
3
+
1. Ensure that your code follows our code conventions: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#code-style-and-linting
4
4
2. Run unit tests and ensure that they are passing: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#unit-tests
5
5
3. If your change introduces any API changes, make sure to update the integration tests here: https://github.com/feast-dev/feast/tree/master/sdk/python/tests
6
6
4. Make sure documentation is updated for your PR!
Setting up your development environment for Feast Python SDK / CLI:
123
+
Setting up your development environment for Feast Python SDK and CLI:
124
124
1. Ensure that you have Docker installed in your environment. Docker is used to provision service dependencies during testing, and build images for feature servers and other components.
125
125
- Please note that we use [Docker with BuiltKit](https://docs.docker.com/develop/develop-images/build_enhancements/).
126
126
-_Alternatively_ - To use [podman](https://podman.io/) on a Fedora or RHEL machine, follow this [guide](https://github.com/feast-dev/feast/issues/4190)
9. Install development dependencies for Feast Python SDK / CLI. This will install package versions from the lock file, install editable version of feast and compile protobufs.
155
+
9. Install development dependencies for Feast Python SDK and CLI. This will install package versions from the lock file, install editable version of feast and compile protobufs.
156
156
157
157
If running inside a virtual environment:
158
158
```sh
@@ -169,8 +169,8 @@ make install-python-ci-dependencies-uv
- Conforms to [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
175
175
- Has type annotations as enforced by `mypy`
176
176
- Has imports sorted by `ruff` (see [isort (I) rules](https://docs.astral.sh/ruff/rules/#isort-i))
@@ -190,15 +190,15 @@ make lint-python
190
190
> Setup [pre-commit hooks](#pre-commit-hooks) to automatically format and lint on commit.
191
191
192
192
### Unit Tests
193
-
Unit tests (`pytest`) for the Feast Python SDK / CLI can run as follows:
193
+
Unit tests (`pytest`) for the Feast Python SDK and CLI can run as follows:
194
194
```sh
195
195
make test-python-unit
196
196
```
197
197
198
198
> :warning: Local configuration can interfere with Unit tests and cause them to fail:
199
199
> - Ensure [no AWS configuration is present](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)
200
200
> and [no AWS credentials can be accessed](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials) by `boto3`
201
-
> - Ensure Feast Python SDK / CLI is not configured with configuration overrides (ie `~/.feast/config` should be empty).
201
+
> - Ensure Feast Python SDK and CLI is not configured with configuration overrides (ie `~/.feast/config` should be empty).
👋👋👋 [Come say hi on Slack!](https://join.slack.com/t/feastopensource/signup)
19
+
17
20
## Overview
18
21
19
22
Feast (**Fea**ture **St**ore) is an open source feature store for machine learning. Feast is the fastest path to manage existing infrastructure to productionize analytic data for model training and online inference.
0 commit comments