Skip to content

Commit 66a0a38

Browse files
authored
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>
1 parent 8181007 commit 66a0a38

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Thanks for sending a pull request! Here are some tips for you:
22
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
44
2. Run unit tests and ensure that they are passing: https://github.com/feast-dev/feast/blob/master/CONTRIBUTING.md#unit-tests
55
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
66
4. Make sure documentation is updated for your PR!

docs/project/development-guide.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
- [Pre-commit Hooks](#pre-commit-hooks)
1515
- [Signing off commits](#signing-off-commits)
1616
- [Incorporating upstream changes from master](#incorporating-upstream-changes-from-master)
17-
- [Feast Python SDK / CLI](#feast-python-sdk--cli)
17+
- [Feast Python SDK and CLI](#feast-python-sdk-and-cli)
1818
- [Environment Setup](#environment-setup)
19-
- [Code Style \& Linting](#code-style--linting)
19+
- [Code Style and Linting](#code-style-and-linting)
2020
- [Unit Tests](#unit-tests)
2121
- [Integration Tests](#integration-tests)
2222
- [Local integration tests](#local-integration-tests)
@@ -39,7 +39,7 @@
3939
## Overview
4040
This guide is targeted at developers looking to contribute to Feast components in
4141
the main Feast repository:
42-
- [Feast Python SDK / CLI](#feast-python-sdk--cli)
42+
- [Feast Python SDK and CLI](#feast-python-sdk-and-cli)
4343
- [Feast Java Serving](#feast-java-serving)
4444

4545
Please see [this page](../reference/codebase-structure.md) for more details on the structure of the entire codebase.
@@ -118,9 +118,9 @@ Our preference is the use of `git rebase [master]` instead of `git merge` : `git
118118
Note that this means if you are midway through working through a PR and rebase, you'll have to force push:
119119
`git push --force-with-lease origin [branch name]`
120120

121-
## Feast Python SDK / CLI
121+
## Feast Python SDK and CLI
122122
### Environment Setup
123-
Setting up your development environment for Feast Python SDK / CLI:
123+
Setting up your development environment for Feast Python SDK and CLI:
124124
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.
125125
- Please note that we use [Docker with BuiltKit](https://docs.docker.com/develop/develop-images/build_enhancements/).
126126
- _Alternatively_ - To use [podman](https://podman.io/) on a Fedora or RHEL machine, follow this [guide](https://github.com/feast-dev/feast/issues/4190)
@@ -152,7 +152,7 @@ curl -fsSL https://pixi.sh/install.sh | bash
152152
```sh
153153
make lock-python-dependencies-all
154154
```
155-
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.
156156

157157
If running inside a virtual environment:
158158
```sh
@@ -169,8 +169,8 @@ make install-python-ci-dependencies-uv
169169
docker build -t docker-whale -f ./sdk/python/feast/infra/feature_servers/multicloud/Dockerfile .
170170
```
171171

172-
### Code Style & Linting
173-
Feast Python SDK / CLI codebase:
172+
### Code Style and Linting
173+
Feast Python SDK and CLI codebase:
174174
- Conforms to [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
175175
- Has type annotations as enforced by `mypy`
176176
- Has imports sorted by `ruff` (see [isort (I) rules](https://docs.astral.sh/ruff/rules/#isort-i))
@@ -190,15 +190,15 @@ make lint-python
190190
> Setup [pre-commit hooks](#pre-commit-hooks) to automatically format and lint on commit.
191191
192192
### 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:
194194
```sh
195195
make test-python-unit
196196
```
197197

198198
> :warning: Local configuration can interfere with Unit tests and cause them to fail:
199199
> - Ensure [no AWS configuration is present](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)
200200
> 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).
202202
203203
### Integration Tests
204204
There are two sets of tests you can run:

infra/templates/README.md.jinja2

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://github.com/feast-dev/feast/blob/master/LICENSE)
1515
[![GitHub Release](https://img.shields.io/github/v/release/feast-dev/feast.svg?style=flat&sort=semver&color=blue)](https://github.com/feast-dev/feast/releases)
1616

17+
## Join us on Slack!
18+
👋👋👋 [Come say hi on Slack!](https://join.slack.com/t/feastopensource/signup)
19+
1720
## Overview
1821

1922
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

Comments
 (0)