From 80a6f85d8b2d6e583946d176d1cd17c6acf2f3e0 Mon Sep 17 00:00:00 2001 From: Christian Grewell Date: Fri, 1 Mar 2024 11:10:59 -0500 Subject: [PATCH 1/2] Update CONTRIBUTING.rst - added windows instructions - added a few suggested areas of contribution - mainly just testing a potential 'dev' workflow --- CONTRIBUTING.rst | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b780b94..bdefc51 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -22,6 +22,12 @@ and additions you could make to the site itself, such as to this document, which tells people nothing about how to contribute at the moment. Regardless of how you choose contribute, as long as it is in good faith, I appreciate it. +Some ideas for contributions include: +- Adding a new app to the site +- Adding a new feature to an existing app +- Adding a new feature to the site +- Adding a new feature to the constitution + .. Adapted from https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html @@ -40,17 +46,33 @@ Make sure to have the following on your host: First things first. +#. Set a project slug!?:: + + $ export project_slug=cookiestocracy + + .. note:: + + ``project_slug`` is the name of the project you want to create. It should be a valid Python package name? + +#. Clone the repository:: + + $ git clone https://github.com/mfosterw/cookiestocracy.git + $ cd cookiestocracy + #. Create a virtualenv:: $ python3.12 -m venv + or + $ conda create -n python=3.12 #. Activate the virtualenv you have just created:: $ source /bin/activate + or + $ conda activate #. Install development requirements:: - $ cd $ pip install -r requirements/local.txt $ git init # A git repo is required for pre-commit to install $ pre-commit install @@ -76,7 +98,13 @@ First things first. #. Set the environment variables for your database(s):: - $ export DATABASE_URL=postgres://postgres:@127.0.0.1:5432/ + MACOS: + $ export DATABASE_URL=postgres://postgres:@127.0.0.1:5432/ + # Optional: set broker URL if using Celery + $ export CELERY_BROKER_URL=redis://localhost:6379/0 + + WINDOWS: + $ set DATABASE_URL=postgres://postgres:@127.0.0.1:5432/ # Optional: set broker URL if using Celery $ export CELERY_BROKER_URL=redis://localhost:6379/0 From 620bb4248251b97ee63c5b1d6640141d7bddbfa5 Mon Sep 17 00:00:00 2001 From: Matthew Foster Walsh <15671892+mfosterw@users.noreply.github.com> Date: Sat, 9 Mar 2024 21:39:34 -0500 Subject: [PATCH 2/2] Update CONTRIBUTING.rst --- CONTRIBUTING.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bdefc51..31743c8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -46,14 +46,6 @@ Make sure to have the following on your host: First things first. -#. Set a project slug!?:: - - $ export project_slug=cookiestocracy - - .. note:: - - ``project_slug`` is the name of the project you want to create. It should be a valid Python package name? - #. Clone the repository:: $ git clone https://github.com/mfosterw/cookiestocracy.git