From b12bc5b4e67cca9d5a0e51ecd8ca11d2b4fcaaf3 Mon Sep 17 00:00:00 2001 From: Brielle Stokes Date: Wed, 14 Feb 2024 17:48:24 -0500 Subject: [PATCH 1/3] README + CONTRIBUTING updates Added setup instructions and resources, links to community spaces, specified issue and request guidelines, gave instructions on linking issues/PRs --- CONTRIBUTING.md | 11 ++++------- README.md | 25 ++++++++++++++++++++++--- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fcce9a9a..95d1b8b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,19 +11,16 @@ In the interest of fostering an open and welcoming environment, please review an All submissions, including submissions by project members, require review. We 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. -## Report an issue +## Report an issue/File a feature request +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. -Report all issues through [GitHub Issues](./issues). - -## File a feature request - -File your feature request through [GitHub Issues](./issues). +Report all issues and file all deature requests through [GitHub Issues](./issues). ## Create a pull request When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features: - 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. -- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change. +- 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. - For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. - For example, if you update documentation for a specific extension, your commit message might be: `docs(extension-name) updated installation documentation`. diff --git a/README.md b/README.md index 07484061..01bbda77 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,28 @@ Python client for [Supabase](https://supabase.com) - [GitHub OAuth in your Python Flask app](https://supabase.com/blog/oauth2-login-python-flask-apps) - [Python data loading with Supabase](https://supabase.com/blog/loading-data-supabase-python) -## Installation +## Set up a Local Development Environment +### Clone the Repository: -We recommend activating your virtual environment. For example, we like `poetry` and `conda`! +```bash +git clone https://github.com/supabase-community/supabase-py.git +cd supabase-py +``` + +### Create and Activate a Virtual Environment: + +We recommend activating your virtual environment. For example, we like `poetry` and `conda`! Click here for more about Python virtual environments and working with conda and poetry. + +Using venv (Python 3 built-in): +```bash +python3 -m venv env +source env/bin/activate # On Windows, use .\env\Scripts\activate +``` +Using conda: +```bash +conda create --name supabase-py +conda activate supabase-py +``` ### PyPi installation @@ -186,7 +205,7 @@ Overall Tasks: ## Contributing -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. +Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on Discord or on our Github Discussions page if you want to get involved. ### Running Tests From 18a49c9aaa4088e43d06a2d85024cc1415efb095 Mon Sep 17 00:00:00 2001 From: Brielle Stokes <113540137+brielle5810@users.noreply.github.com> Date: Wed, 14 Feb 2024 19:34:42 -0500 Subject: [PATCH 2/3] Fixed typo Fixed a typo of the word feature --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95d1b8b0..c9e12a74 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ use GitHub pull requests for this purpose. After filing a pull request, please t ## Report an issue/File a feature request 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. -Report all issues and file all deature requests through [GitHub Issues](./issues). +Report all issues and file all feature requests through [GitHub Issues](./issues). ## Create a pull request From b2f57a1ee23239da2df752870c684b79ad5ca9d9 Mon Sep 17 00:00:00 2001 From: Brielle Stokes <113540137+brielle5810@users.noreply.github.com> Date: Wed, 14 Feb 2024 19:43:39 -0500 Subject: [PATCH 3/3] changed discussions link to general supabase Changed GitHub Discussions link to the main Github discussions since the other will be discontinued --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01bbda77..0a134ce4 100644 --- a/README.md +++ b/README.md @@ -205,7 +205,7 @@ Overall Tasks: ## Contributing -Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on Discord or on our Github Discussions page if you want to get involved. +Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on Discord or on our Github Discussions page if you want to get involved. ### Running Tests