Skip to content

Commit 846d8e7

Browse files
authored
docs (sunbase-py) updated setup instructions, PR guidelines, added resources & links (#690)
1 parent 13bed26 commit 846d8e7

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

CONTRIBUTING.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,16 @@ In the interest of fostering an open and welcoming environment, please review an
1111
All submissions, including submissions by project members, require review. We
1212
use GitHub pull requests for this purpose. After filing a pull request, please tag any two of the [current maintainers](./MAINTAINERS.md) to request a review.
1313

14-
## Report an issue
14+
## Report an issue/File a feature request
15+
Before opening a new issue or request, please take a moment to check the existing issues and discussions to see if your topic has already been addressed. This helps us avoid duplicate issues and keeps the conversation focused.
1516

16-
Report all issues through [GitHub Issues](./issues).
17-
18-
## File a feature request
19-
20-
File your feature request through [GitHub Issues](./issues).
17+
Report all issues and file all feature requests through [GitHub Issues](./issues).
2118

2219
## Create a pull request
2320

2421
When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features:
2522

2623
- Before creating a pull request, file a GitHub Issue so that maintainers and the community can discuss the problem and potential solutions before you spend time on an implementation.
27-
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change.
24+
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change. To link to an existing issue or pull request in your PR, use the # symbol followed by the issue or PR number. For example, to link to issue number 123, you would write #123 in your PR's description. GitHub will automatically create a link to the issue.
2825
- For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
2926
- For example, if you update documentation for a specific extension, your commit message might be: `docs(extension-name) updated installation documentation`.

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,28 @@ Python client for [Supabase](https://supabase.com)
77
- [GitHub OAuth in your Python Flask app](https://supabase.com/blog/oauth2-login-python-flask-apps)
88
- [Python data loading with Supabase](https://supabase.com/blog/loading-data-supabase-python)
99

10-
## Installation
10+
## Set up a Local Development Environment
11+
### Clone the Repository:
1112

12-
We recommend activating your virtual environment. For example, we like `poetry` and `conda`!
13+
```bash
14+
git clone https://github.com/supabase-community/supabase-py.git
15+
cd supabase-py
16+
```
17+
18+
### Create and Activate a Virtual Environment:
19+
20+
We recommend activating your virtual environment. For example, we like `poetry` and `conda`! Click <a href="https://docs.python.org/3/library/venv.html">here</a> for more about Python virtual environments and working with <a href="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment">conda</a> and <a href="https://python-poetry.org/docs/basic-usage/">poetry</a>.
21+
22+
Using venv (Python 3 built-in):
23+
```bash
24+
python3 -m venv env
25+
source env/bin/activate # On Windows, use .\env\Scripts\activate
26+
```
27+
Using conda:
28+
```bash
29+
conda create --name supabase-py
30+
conda activate supabase-py
31+
```
1332

1433
### PyPi installation
1534

@@ -186,7 +205,7 @@ Overall Tasks:
186205

187206
## Contributing
188207

189-
Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on Discord if you want to get involved.
208+
Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on <a href="https://discord.supabase.com/">Discord</a> or on our <a href="https://github.com/orgs/supabase/discussions">Github Discussions</a> page if you want to get involved.
190209

191210
### Running Tests
192211

0 commit comments

Comments
 (0)