diff --git a/.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md b/.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md index 3ceab1aa..5725049d 100644 --- a/.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md +++ b/.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md @@ -2,7 +2,7 @@ name: Add project logo or image to your main repository about: Simple action that will make it possible to add project to hackforla.org website title: '' -labels: enhancement +labels: 'complexity: medium, enhancement, feature: branding, milestone: missing, role: product, s: PD team, size: 1pt' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/add-seed-data-to-a-table.md b/.github/ISSUE_TEMPLATE/add-seed-data-to-a-table.md index ca4a4bfb..b75eef6d 100644 --- a/.github/ISSUE_TEMPLATE/add-seed-data-to-a-table.md +++ b/.github/ISSUE_TEMPLATE/add-seed-data-to-a-table.md @@ -3,8 +3,7 @@ name: Add seed data to a table about: For adding data that will be the same no matter what organization uses People Depot title: 'Add seed data for Table: [Replace with TABLE NAME]' -labels: 'good first issue, role: back end, s: CTJ, s: hackforla.org, s: kb, s: org, - s: PD team, s: tables, s: VRMS, size: 1pt' +labels: 'good first issue, role: back end, s: missing, size: 1pt, complexity: small, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md index 998f844b..234897c8 100644 --- a/.github/ISSUE_TEMPLATE/blank-issue.md +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -2,7 +2,7 @@ name: Blank Issue about: Consistent formatting makes Issues concise and easy to navigate. title: '' -labels: '' +labels: 'role: missing, size: missing, feature: missing, stakeholder: missing, complexity: missing, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md b/.github/ISSUE_TEMPLATE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md index 9c568faa..b28a26a8 100644 --- a/.github/ISSUE_TEMPLATE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md +++ b/.github/ISSUE_TEMPLATE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md @@ -1,8 +1,8 @@ --- -name: Control what appears when you paste your sites link in social media sites +name: Control what appears when you paste your site's link in social media sites about: Add Open Graph Markup tags to header -title: Control what appears when you paste your sites link in social media sites -labels: enhancement, question +title: Control what appears when you paste your site's link in social media sites +labels: 'role: product, size: 0.25, feature: branding, s: PD team, complexity: small, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/create-agenda.md b/.github/ISSUE_TEMPLATE/create-agenda.md index 132f47a2..1dc7dda4 100644 --- a/.github/ISSUE_TEMPLATE/create-agenda.md +++ b/.github/ISSUE_TEMPLATE/create-agenda.md @@ -2,8 +2,9 @@ name: Create Agenda about: Assign issue to all team members day after meetup in prep for next meetup title: '' -labels: documentation, help wanted, question +labels: 'role: product, feature: agenda, s: PD team, complexity: small, size: 0.25pt' assignees: '' +milestone: '05. Team Workflow' --- diff --git a/.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md b/.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md index 702fdcaa..cafa3c9d 100644 --- a/.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md +++ b/.github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md @@ -2,8 +2,9 @@ name: Create project card for [project name] about: Gather information to add this project to HackforLA's website title: '' -labels: documentation, good first issue, question +labels: 'complexity: small, role: product, size: 1pt, feature: branding, s: PD team, s: hackforla.org, complexity: small' assignees: '' +milestone: '03. Org Requirements' --- diff --git a/.github/ISSUE_TEMPLATE/create-table-issue-template.md b/.github/ISSUE_TEMPLATE/create-table-issue-template.md index 81cea28c..961063f8 100644 --- a/.github/ISSUE_TEMPLATE/create-table-issue-template.md +++ b/.github/ISSUE_TEMPLATE/create-table-issue-template.md @@ -2,7 +2,7 @@ name: Create Table issue template about: Create an issue for each table required title: 'Create Table: [name of table]' -labels: 'role: back end, size: 2pt' +labels: 'role: back end, size: 2pt, feature: table creation, s: hackforla.org, s: VRMS, s: CTJ, s: tables, s: kb, complexity: missing, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/emergent-request.md b/.github/ISSUE_TEMPLATE/emergent-request.md index c0402d9d..b95993ad 100644 --- a/.github/ISSUE_TEMPLATE/emergent-request.md +++ b/.github/ISSUE_TEMPLATE/emergent-request.md @@ -3,7 +3,7 @@ name: Emergent Request about: When you discover something in your issue that is out of scope and it needs a new issue or discussion title: 'ER: [replace with info ]' -labels: 'size: 0.25pt' +labels: 'role: missing, size: 0.25pt, feature: missing, stakeholder: missing, complexity: missing, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f2819b22..00f9b202 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: 'Feature Suggestion: ' -labels: documentation +labels: 'enhancement, documentation, role: missing, size: missing, feature: missing, stakeholder: missing, complexity: missing, milestone: missing' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/lighthouse--cross-origin-destinations-are-unsafe.md b/.github/ISSUE_TEMPLATE/lighthouse--cross-origin-destinations-are-unsafe.md deleted file mode 100644 index a9418826..00000000 --- a/.github/ISSUE_TEMPLATE/lighthouse--cross-origin-destinations-are-unsafe.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: 'Lighthouse: Cross-origin destinations are unsafe' -about: Instructions for addressing the cross-origin linking vulnerabilities -title: 'Lighthouse Issue: Cross-origin destinations are unsafe' -labels: '' -assignees: '' - ---- - -### Overview - -Links to cross-origin destinations are unsafe both from a security and performance perspective. - -### Action Item - -Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in [cross-origin destinations are unsafe](https://developers.google.com/web/tools/lighthouse/audits/noopener). - -## Summary of instructions - -When using *target=\_blank* also adding *rel="noopener"* to the tag ensures that new page runs in a separate process. diff --git a/.github/ISSUE_TEMPLATE/post-open-role.md b/.github/ISSUE_TEMPLATE/post-open-role.md index b3702df3..76e71da0 100644 --- a/.github/ISSUE_TEMPLATE/post-open-role.md +++ b/.github/ISSUE_TEMPLATE/post-open-role.md @@ -2,8 +2,9 @@ name: Post an open role about: Recruit volunteers for specific open roles template title: 'PD: Open Role for: [Replace with NAME OF ROLE]' -labels: 'complexity: small, feature: recruiting, role: missing, size: 0.25pt' +labels: 'complexity: small, feature: recruiting, role: missing, size: 0.25pt, s: PD team' assignees: '' +milestone: '05. Team Workflow' --- diff --git a/.github/ISSUE_TEMPLATE/update-content-for-readme-file.md b/.github/ISSUE_TEMPLATE/update-content-for-readme-file.md index a4168b28..5dd00440 100644 --- a/.github/ISSUE_TEMPLATE/update-content-for-readme-file.md +++ b/.github/ISSUE_TEMPLATE/update-content-for-readme-file.md @@ -2,8 +2,9 @@ name: Update Content for ReadMe file about: Instructions for revising the README.md file inside this repository title: '' -labels: documentation, good first issue, help wanted, question +labels: 'documentation, good first issue, help wanted, question, role: missing, size: missing, feature: docs: PD team documentation, s: PD team, complexity: missing' assignees: '' +milestone: '04. Project Setup' --- diff --git a/.github/ISSUE_TEMPLATE/update-team-roster.md b/.github/ISSUE_TEMPLATE/update-team-roster.md index fb3a48e3..bf2410de 100644 --- a/.github/ISSUE_TEMPLATE/update-team-roster.md +++ b/.github/ISSUE_TEMPLATE/update-team-roster.md @@ -2,8 +2,9 @@ name: Update Team Roster about: Provides new team members a link to team roster to input their information title: '' -labels: documentation, good first issue, question +labels: 'documentation, good first issue, question, role: missing, size: 0.25pt, feature: PD team recruit/onboard/offboard, s: PD team, complexity: small' assignees: '' +milestone: '05. Team Workflow' --- diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 15979dcb..2f7d220f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -141,7 +141,6 @@ repos: exclude: | (?x)^( .github/ISSUE_TEMPLATE/| - docs/CONTRIBUTING.md$| docs/index.md$| docs/license.md$ ) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a03d90cb..7469b143 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,439 +1,11 @@ # Contributing -Thank you for volunteering your time! The following is a set of guidelines for contributing to the peopledepot repository, which is hosted on GitHub. +Thank you for volunteering your time! -**Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the [Getting Started Page](https://www.hackforla.org/getting-started).** _Workshop attendees are granted a temporary exception from this requirement._ +Here are the recommended steps for contributing: -## 1. Joining Repository Team +1. Join the team +1. Take an issue +1. Fork, modify, and submit pull request -This step is optional if this is your first time fixing an issue and you want to try fixing an issue without this step. - -In the `people-depot` Slack channel, send an introductory message with your GitHub handle/username asking to be added to the Hack for LA peopledepot GitHub repository, have access to the Google Docs Drive, and Figma. - -!!! note "Please do the following once you have accepted the GitHub invite (comes via email or in your GitHub notifications)" - Make your own Hack for LA GitHub organization membership public by following this [guide](https://help.github.com/en/articles/publicizing-or-hiding-organization-membership#changing-the-visibility-of-your-organization-membership). - -## 2. Setting Up Development Environment - -### 2.1 Pre-requisites - -#### 2.1.1 GitHub account - -See [here](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account#signing-up-for-a-new-account) for creating a GitHub account. If you are not familiar with Git, [this tutorial](https://docs.github.com/en/get-started/quickstart/hello-world) is recommended. - -#### 2.1.2 Two-factor authentication - -Set up two-factor authentication on your account by following this [guide](https://docs.github.com/en/github/authenticating-to-github/configuring-two-factor-authentication). - -#### 2.1.3 Text editor - -[VS Code](https://code.visualstudio.com/download) is recommended, but feel free to use a text editor of your choice. - -#### 2.1.4 Install Git - -Before cloning your forked repository to your local machine, you must have Git installed. You can find instructions for installing Git for your operating system [**here**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). - -=== "Windows" - - we recommend [installing Windows Subsystem for Linux (WSL)](https://code.visualstudio.com/docs/remote/wsl). WSL provides a Linux-compatible environment that can prevent common errors during script execution. - - - After setting up WSL, install Git directly from the Linux terminal. This method can help avoid complications that sometimes arise when using Git Bash on Windows. - - - If you prefer Git Bash or encounter errors related to line endings when running scripts, the problem might be due to file conversions in Windows. To address this, configure Git as follows: - - ```bash - git config --system set autocrlf=false - ``` - - !!! tip "Feel free to reach out in the [Hack for LA Slack channel](https://hackforla.slack.com/messages/people-depot/) if you encounter any errors while running scripts on Windows" - -=== "Mac" - Please note that if you have a Mac the page offers several options (see other option, if you need to conserve hard drive space) including: - - - an “easiest” option (this version is fine for our use): This option would take just over 4GB. - - a “more up to date” option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew. - - Other option: If your computer is low on space, you can use this [tutorial](https://www.datacamp.com/community/tutorials/homebrew-install-use) to install XCode Command Tools and a lighter version of Homebrew and then install Git using this command: `$ brew install git` which in total only uses 300MB. - -#### 2.1.5 Install Docker - -Install or make sure [docker][docker-install] and [docker-compose][docker-compose-install] are installed on your computer - -```bash -docker -v -docker-compose -v -``` - -The recommended installation method for your operating system can be found [here](https://docs.docker.com/install/). - -!!! tip "Feel free to reach out in the [Hack for LA Slack channel](https://hackforla.slack.com/messages/people-depot/) if you have trouble installing docker on your system" - -More on using Docker and the concepts of containerization: - -- [Get started with Docker](https://docs.docker.com/get-started/) - -### 2.2 Fork the repository - -You can fork the hackforla/peopledepot repository by clicking -. A fork is a copy of the repository that will be placed on your GitHub account. - -!!! note "It should create a URL that looks like the following -> `https://github.com//peopledepot`" - !!! example "For example -> `https://github.com/octocat/peopledepot`" - -!!! info "What you have created is a forked copy in a remote version on GitHub. It is not on your local machine yet" - -#### 2.2.1 Clone a copy on your computer - -The following steps will clone (create) a local copy of the forked repository on your computer. - -1. Create a new folder in your computer that will contain `hackforla` projects. - - In your command line interface (Terminal, Git Bash, Powershell), move to where you want your new folder to be placed and create a new folder in your computer that will contain `hackforla` projects. After that, navigate into the folder(directory) you just created. - - For example: - - ```bash - cd /projects - mkdir hackforla - cd hackforla - ``` - -1. From the hackforla directory created in previous section: - - ```bash - git clone https://github.com//peopledepot.git - ``` - - For example if your GitHub username was `octocat`: - - ```bash - git clone https://github.com/octocat/peopledepot.git - ``` - - !!! note "You can also clone using ssh which is more secure but requires more setup. Because of the additional setup, cloning using https as shown above is recommended" - -You should now have a new folder in your `hackforla` folder called `peopledepot`. Verify this by changing into the new directory: - -```bash -cd peopledepot -``` - -#### 2.2.2 Verify and set up remote references - -Verify that your local cloned repository is pointing to the correct `origin` URL (that is, the forked repo on your own GitHub account): - -```bash -git remote -v -``` - -You should see `fetch` and `push` URLs with links to your forked repository under your account (i.e. `https://github.com//peopledepot.git`). You are all set to make working changes to the project on your local machine. - -However, we still need a way to keep our local repo up to date with the deployed project. To do so, you must add an upstream remote to incorporate changes made while you are working on your local repo. Run the following to add an upstream remote URL & update your local repo with recent changes to the `hackforla` version: - -```bash -git remote add upstream https://github.com/hackforla/peopledepot.git -git fetch upstream -``` - -After adding the upstream remote, you should now see it if you again run `git remote -v` : - -```bash -origin https://github.com//peopledepot.git (fetch) -origin https://github.com//peopledepot.git (push) -upstream https://github.com/hackforla/peopledepot.git (fetch) -upstream https://github.com/hackforla/peopledepot.git (push) -``` - -### 2.3 Build and run using Docker locally - -1. Make sure the Docker service is running - - === "Docker (Engine)" - ```bash - sudo systemctl status docker - ``` - - It will show `Active: active (running)` if it's running. - - === "Docker Desktop" - 1. Start Docker Desktop - 1. Run `docker container ls` to verify Docker Desktop is running. If it is not running you will get the message: `Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?` - -1. Create an .env.docker file from .env.docker-example - - ```bash - cp ./app/.env.docker-example ./app/.env.docker - ``` - -1. Build and run the project via the script (this includes running `docker-compose up`) - - ```bash - ./scripts/buildrun.sh - ``` - -1. Create a super user for logging into the web admin interface - - ```bash - docker-compose exec web python manage.py createsuperuser --no-input - ``` - -1. Browse to the web admin interface at `http://localhost:8000/admin/` and confirm the admin site is running. Use DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD from .env.docker for credentials. - -## 3. Managing Docker - -### 3.1 Stopping Docker - -To stop the service-container, but not destroy it (often sufficient for day-to-day work): - -```bash -docker-compose stop -``` - -To stop and destroy the service container: - -```bash -docker-compose down -``` - -Add the `-v` flag to destroy the data volumes as well: - -```bash -docker-compose down -v -``` - -### 3.2 Recycling / Refreshing Database - -To restore a database to its original state and remove any data manually added, delete the container and image. -From Docker: - -=== "Terminal" - ```bash - docker-compose down -v - ``` - -=== "Docker Desktop" - 1. Open Containers section - 1. Delete people-db-1 container - 1. Open Images Tab - 1. Remove djangorestapipostrgresql image - -## 4. Fixing Issues - -### 4.1 Find an issue - -Find an issue in Prioritized Backlog [here](https://github.com/hackforla/peopledepot/projects/1#column-16900748) - -If you joined the peopledepot repository as described in a previous section: - -1. Assign the issue to yourself and move it to "In progress" column. -1. Follow the steps in the issue description to complete the issue. -1. Make sure to comment your ETA and Availability when you first assign yourself. - -If you don't have privileges, add a comment that you are working on the issue. - -### 4.2 Create a new branch - -Once you have selected an issue to work on, create a branch for that issue. - -Verify you are on the `main` branch. - -```bash -git branch -``` - -You will see a list of all of your branches. There will be a star (`*`) next to the branch that you are currently in. By default you should start on the `main` branch. - -If you are not currently in the `main` branch, run the following command to return to it: - -```bash -git checkout main -``` - -```bash -git pull origin main -``` - -This ensures you have the most recent code, which is important if you previously cloned and it has been more than a day. - -Create a new branch where you will work on the issue. The branch name should include the issue number. For example, to create a new branch for issue 15 and change into it: - -```bash -git checkout -b -15 -``` - -### 4.3 Make changes - -Make changes to fix the issue. If creating a new table or API, read [Add Model and API End Points](how-to/add-model-and-api-endpoints.md). - -### 4.4 Pull to get the most recent code - -You can probably skip this if you fix the issue on the same day that you pulled the code. - -```bash -git pull -``` - -!!! note "If you are using Visual studios code you can use the Git graphical user interface to stage your changes. For instructions check out the [Git GUI page in the website Wiki]()" - -### 4.5 Add changed files to staging - -**Make sure you are on your issue branch (instead of `main`)** - -```bash -git branch -``` - -You must add your files to the staging area before you can commit (save them to git). - -Run this command if you want to **add changes from a specific file to your commit record**: - -```bash -git add “filename.ext” -``` - -Run this command if you want to **add all changes to all file(s) to your commit record**: - -```bash -git add . -``` - -### 4.6 Check Git status - -This command will list the files that have been staged with green text. These are the files that will be committed (saved) when you run the next command, `git commit`. Please be sure all your staged changes are relevant to the issue you are working on. If you accidentally included unrelated changes, please unstage them before making this commit, and then make a new commit for the unrelated changes. (The commands for unstaging commits are provided in the output of your `git status` command.) - -```bash -git status -``` - -### 4.7 Remove files that you don't want staged - -This command will unstage a file that you don't want included in the commit. The specified file will not be committed (saved) when you run the next command, `git commit`. This only works if the wrong files were added, but they were not yet committed. (See [this tutorial](https://www.atlassian.com/git/tutorials/resetting-checking-out-and-reverting) for an in-depth discussion.) The file will be removed from the staging area, but not actually deleted: - -```bash -git reset HEAD “filename.ext” -``` - -### 4.8 Install pre-commit - -This will check your changes for common problems. - -See the [Pre-commit page](tools/pre-commit.md) for installation instructions. - -For consistency, an automated bot will perform the same checks on the repository side when you open a pull request. - -### 4.9 Commit staged changes - -This command saves your work, and prepares it to push to your repository. Use the `-m` flag to quickly add a message to your commit. Your message should be a short description of the changes you made. It will be extremely helpful if other people can understand your message, so try to resist the temptation to be overly cryptic. - -To commit your changes with a message, run: - -```bash -git commit -m “insert message here” -``` - -Ensure that your local repository is up-to-date with the main site: - -```bash -git pull upstream -``` - -You can also sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch" - -### 4.10 Push to upstream origin (aka, your fork) - -Push your local branch to your remote repository: - -```bash -git push --set-upstream origin -``` - -Alternatively, you can run - -```bash -git push -``` - -### 4.11 Create a pull request - -#### 4.11.1 Push all changes in your issue branch - -Once you are satisfied with your changes, push them to the feature branch you made within your remote repository. - -```bash -git push --set-upstream origin -``` - -#### 4.11.2 Complete pull request from GitHub - -1. Click the green button to create a Pull Request (PR) -1. Add a short title in the subject line -1. In the body of the comment, add the following, replacing `` with the issue you worked on: - -```bash -fixes # -``` - -1. Below this, add a brief description of the changes you made -1. Click the green "Create pull request" button -1. Add the PR to the project board - -## 5. Documentation - -We highly encourage contributors to add and update documentation in the same pull request as the code. This will ensure that the docs and features are synchronized. - -Please see the [MkDocs page](tools/mkdocs.md) for how to view documentation changes locally using the mkdocs in docker. - -## 6. Sync Main Changes - -Your fork of this repository on GitHub, and your local clone of that fork, will get out of sync with the (upstream) repository as others update the repository. (That's what has happened when you see something like "This branch is 1 commit behind peopledepot:main" on your forked repository.) - -One way to keep your fork up to date with this repository is to follow these instruction: [Syncing your fork to the original repository via the browser](https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser) - -You can also update your fork via the local clone of your fork, using these instructions. Assuming you have a local clone with remotes `upstream` (this repo) and `origin` (your GitHub fork of this repo): - -- First, you will need to create a local branch which tracks upstream/main. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes. - -Run the following two commands: - -```bash -git fetch upstream -git checkout -b upstream-main --track upstream/main -``` - -If you have already created the branch upstream-main, the following commands will incorporate upstream changes: - -```bash -git checkout upstream-main # Move to the branch you want to merge with. -git pull # This updates your tracking branch to match the main branch in this repository -git checkout main # Move back to your main branch -git merge upstream-main # Merge to bring your main current. -``` - -If you do all your work on topic branches (as suggested above) and keep main free of local modifications, this merge should apply cleanly. - -Then push the merge changes to your GitHub fork: - -```bash -git push -``` - -If you go to your online GitHub repository this should remove the message "This branch is x commit behind peopledepot:main". - -## 7. Creating Issues - -To create a new issue, please use the blank issue template (available when you click New Issue). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link. - -# Appendix - -## A. Submitting Bugs for Third Party Packages / Apps - -You can go to these links and submit an issue: - -- [Docker](https://github.com/docker) -- [Flake8][flake8-docs] -- [Black][black-docs] -- [isort][isort-docs] - -[black-docs]: https://github.com/psf/black -[docker-compose-install]: https://docs.docker.com/compose/install/ -[docker-install]: https://docs.docker.com/get-docker/ -[flake8-docs]: https://github.com/pycqa/flake8 -[isort-docs]: https://github.com/pycqa/isort/ +Please see the [contributing section](http://hackforla.github.io/peopledepot/contributing/) for more information. diff --git a/README.md b/README.md index 19748e89..e4af24dc 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ This repository uses the [GNU General Public License (v2.0)][licensing]. -[contributing]: ./CONTRIBUTING.md +[contributing]: http://hackforla.github.io/peopledepot/contributing/ [django-docs]: https://docs.djangoproject.com/ [docker-docs]: https://www.postgresql.org/docs/ [drf-docs]: https://www.django-rest-framework.org/tutorial/quickstart/ diff --git a/app/Dockerfile b/app/Dockerfile index 056908ab..52f9df7d 100644 --- a/app/Dockerfile +++ b/app/Dockerfile @@ -5,8 +5,8 @@ FROM python:3.10-alpine WORKDIR /usr/src/app # set environment variables -ENV PYTHONDONTWRITEBYTECODE 1 -ENV PYTHONUNBUFFERED 1 +ENV PYTHONDONTWRITEBYTECODE=1 +ENV PYTHONUNBUFFERED=1 ENV PYTHONPYCACHEPREFIX=/root/.cache/pycache/ # install system dependencies diff --git a/app/core/api/serializers.py b/app/core/api/serializers.py index eccb3902..0d312c64 100644 --- a/app/core/api/serializers.py +++ b/app/core/api/serializers.py @@ -101,6 +101,8 @@ class Meta: class ProjectSerializer(serializers.ModelSerializer): """Used to retrieve project info""" + program_areas = serializers.StringRelatedField(many=True) + class Meta: model = Project fields = ( @@ -117,6 +119,7 @@ class Meta: "image_logo", "image_hero", "image_icon", + "program_areas", ) read_only_fields = ( "uuid", @@ -227,9 +230,11 @@ class Meta: class ProgramAreaSerializer(serializers.ModelSerializer): """Used to retrieve program_area info""" + projects = serializers.StringRelatedField(many=True) + class Meta: model = ProgramArea - fields = ("uuid", "name", "description", "image") + fields = ("uuid", "name", "description", "image", "projects") read_only_fields = ("uuid", "created_at", "updated_at") diff --git a/app/core/migrations/0028_alter_userpermission_project.py b/app/core/migrations/0028_alter_userpermission_project.py new file mode 100644 index 00000000..7e54a092 --- /dev/null +++ b/app/core/migrations/0028_alter_userpermission_project.py @@ -0,0 +1,24 @@ +# Generated by Django 4.2.11 on 2024-09-24 18:46 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ("core", "0027_socmajor"), + ] + + operations = [ + migrations.AlterField( + model_name="userpermission", + name="project", + field=models.ForeignKey( + blank=True, + null=True, + on_delete=django.db.models.deletion.CASCADE, + to="core.project", + ), + ), + ] diff --git a/app/core/migrations/0029_projectprogramareaxref_project_program_areas.py b/app/core/migrations/0029_projectprogramareaxref_project_program_areas.py new file mode 100644 index 00000000..44bd5c2a --- /dev/null +++ b/app/core/migrations/0029_projectprogramareaxref_project_program_areas.py @@ -0,0 +1,64 @@ +# Generated by Django 4.2.11 on 2024-11-01 14:57 + +from django.db import migrations, models +import django.db.models.deletion +import uuid + + +class Migration(migrations.Migration): + + dependencies = [ + ("core", "0028_alter_userpermission_project"), + ] + + operations = [ + migrations.CreateModel( + name="ProjectProgramAreaXref", + fields=[ + ( + "uuid", + models.UUIDField( + default=uuid.uuid4, + editable=False, + primary_key=True, + serialize=False, + unique=True, + ), + ), + ( + "created_at", + models.DateTimeField(auto_now_add=True, verbose_name="Created at"), + ), + ( + "updated_at", + models.DateTimeField(auto_now=True, verbose_name="Updated at"), + ), + ( + "program_area_id", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + to="core.programarea", + ), + ), + ( + "project_id", + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, to="core.project" + ), + ), + ], + options={ + "abstract": False, + }, + ), + migrations.AddField( + model_name="project", + name="program_areas", + field=models.ManyToManyField( + blank=True, + related_name="projects", + through="core.ProjectProgramAreaXref", + to="core.programarea", + ), + ), + ] diff --git a/app/core/migrations/max_migration.txt b/app/core/migrations/max_migration.txt index 49e70d1d..91821a07 100644 --- a/app/core/migrations/max_migration.txt +++ b/app/core/migrations/max_migration.txt @@ -1 +1 @@ -0027_socmajor +0029_projectprogramareaxref_project_program_areas diff --git a/app/core/models.py b/app/core/models.py index b49ecee7..722bca1a 100644 --- a/app/core/models.py +++ b/app/core/models.py @@ -144,6 +144,12 @@ class Project(AbstractBaseModel): image_logo = models.URLField(blank=True) image_hero = models.URLField(blank=True) image_icon = models.URLField(blank=True) + program_areas = models.ManyToManyField( + "ProgramArea", + related_name="projects", + blank=True, + through="ProjectProgramAreaXref", + ) def __str__(self): return f"{self.name}" @@ -302,7 +308,9 @@ class UserPermission(AbstractBaseModel): practice_area = models.ForeignKey( PracticeArea, on_delete=models.CASCADE, blank=True, null=True ) - project = models.ForeignKey(Project, on_delete=models.CASCADE) + project = models.ForeignKey( + Project, blank=True, null=True, on_delete=models.CASCADE + ) class Meta: constraints = [ @@ -424,3 +432,8 @@ class SocMajor(AbstractBaseModel): def __str__(self): return self.title + + +class ProjectProgramAreaXref(AbstractBaseModel): + project_id = models.ForeignKey(Project, on_delete=models.CASCADE) + program_area_id = models.ForeignKey(ProgramArea, on_delete=models.CASCADE) diff --git a/app/core/tests/test_api.py b/app/core/tests/test_api.py index 661d546f..f9a6cb41 100644 --- a/app/core/tests/test_api.py +++ b/app/core/tests/test_api.py @@ -18,10 +18,11 @@ FAQS_VIEWED_URL = reverse("faq-viewed-list") AFFILIATE_URL = reverse("affiliate-list") LOCATION_URL = reverse("location-list") -PROGRAM_AREA_URL = reverse("program-area-list") +PROGRAM_AREAS_URL = reverse("program-area-list") SKILL_URL = reverse("skill-list") STACK_ELEMENT_URL = reverse("stack-element-list") PERMISSION_TYPE = reverse("permission-type-list") +PROJECTS_URL = reverse("project-list") STACK_ELEMENT_TYPE_URL = reverse("stack-element-type-list") SDG_URL = reverse("sdg-list") AFFILIATION_URL = reverse("affiliation-list") @@ -258,7 +259,7 @@ def test_create_program_area(auth_client): "description": "About program area", "image": "http://www.imageurl.com", } - res = auth_client.post(PROGRAM_AREA_URL, payload) + res = auth_client.post(PROGRAM_AREAS_URL, payload) assert res.status_code == status.HTTP_201_CREATED assert res.data["name"] == payload["name"] @@ -271,9 +272,9 @@ def test_list_program_area(auth_client): "description": "About program area", "image": "http://www.imageurl.com", } - res = auth_client.post(PROGRAM_AREA_URL, payload) + res = auth_client.post(PROGRAM_AREAS_URL, payload) - res = auth_client.get(PROGRAM_AREA_URL) + res = auth_client.get(PROGRAM_AREAS_URL) program_areas = ProgramArea.objects.all() expected_data = ProgramAreaSerializer(program_areas, many=True).data @@ -381,3 +382,24 @@ def test_create_soc_major(auth_client): res = auth_client.post(SOC_MAJOR_URL, payload) assert res.status_code == status.HTTP_201_CREATED assert res.data["title"] == payload["title"] + + +def test_project_program_area_xref(auth_client, project, program_area): + def get_object(objects, target_uuid): + for obj in objects: + if str(obj["uuid"]) == str(target_uuid): + return obj + return None + + project.program_areas.add(program_area) + proj_res = auth_client.get(PROJECTS_URL) + test_proj = get_object(proj_res.data, project.uuid) + assert test_proj is not None + assert len(test_proj["program_areas"]) == 1 + assert program_area.name in test_proj["program_areas"] + + program_area_res = auth_client.get(PROGRAM_AREAS_URL) + test_program_ar = get_object(program_area_res.data, program_area.uuid) + assert test_program_ar is not None + assert len(test_program_ar["projects"]) == 1 + assert project.name in test_program_ar["projects"] diff --git a/app/core/tests/test_models.py b/app/core/tests/test_models.py index 9617496e..0438e445 100644 --- a/app/core/tests/test_models.py +++ b/app/core/tests/test_models.py @@ -3,6 +3,8 @@ import pytest from ..models import Event +from ..models import ProgramArea +from ..models import ProjectProgramAreaXref pytestmark = pytest.mark.django_db @@ -145,3 +147,21 @@ def test_check_type(check_type): def test_soc_major(soc_major): assert str(soc_major) == "Test Soc Major" + + +def test_project_program_area_relationship(project): + workforce_development_program_area = ProgramArea.objects.get( + name="Workforce Development" + ) + project.program_areas.add(workforce_development_program_area) + assert project.program_areas.count() == 1 + assert project.program_areas.contains(workforce_development_program_area) + assert workforce_development_program_area.projects.contains(project) + workforce_development_program_area_xref = ProjectProgramAreaXref.objects.get( + project_id=project, program_area_id=workforce_development_program_area + ) + assert workforce_development_program_area_xref.created_at is not None + project.program_areas.remove(workforce_development_program_area) + assert project.program_areas.count() == 0 + assert not workforce_development_program_area.projects.contains(project) + assert not project.program_areas.contains(workforce_development_program_area) diff --git a/docker-compose.yml b/docker-compose.yml index 69e78df8..824ad038 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -version: '3.8' - services: web: build: ./app diff --git a/docs/.pages b/docs/.pages index 0e1a6421..4441258b 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,11 +1,7 @@ nav: - index.md - - Get Started: - - CONTRIBUTING.md - architecture - ref - howto - - how-to - - tools - - ... + - contributing - license.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index ea38c9bf..00000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ ---8<-- "CONTRIBUTING.md" diff --git a/docs/contributing/.pages b/docs/contributing/.pages new file mode 100644 index 00000000..b2d1873f --- /dev/null +++ b/docs/contributing/.pages @@ -0,0 +1,9 @@ +nav: + - team.md + - dev_environment.md + - issues.md + - git.md + - documentation.md + - howto + - ... + - tools diff --git a/docs/contributing/dev_environment.md b/docs/contributing/dev_environment.md new file mode 100644 index 00000000..4e12ac25 --- /dev/null +++ b/docs/contributing/dev_environment.md @@ -0,0 +1,176 @@ +# Development Environment + +## Pre-requisites + +### GitHub account + +See [here](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account#signing-up-for-a-new-account) for creating a GitHub account. If you are not familiar with Git, [this tutorial](https://docs.github.com/en/get-started/quickstart/hello-world) is recommended. + +### Two-factor authentication + +Set up two-factor authentication on your account by following this [guide](https://docs.github.com/en/github/authenticating-to-github/configuring-two-factor-authentication). + +### Text editor + +[VS Code](https://code.visualstudio.com/download) is recommended, but feel free to use a text editor of your choice. + +### Install Git + +Before cloning your forked repository to your local machine, you must have Git installed. You can find instructions for installing Git for your operating system [**here**](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). + +=== "Windows" + - we recommend [installing Windows Subsystem for Linux (WSL)](https://code.visualstudio.com/docs/remote/wsl). WSL provides a Linux-compatible environment that can prevent common errors during script execution. + + - After setting up WSL, install Git directly from the Linux terminal. This method can help avoid complications that sometimes arise when using Git Bash on Windows. + + - If you prefer Git Bash or encounter errors related to line endings when running scripts, the problem might be due to file conversions in Windows. To address this, configure Git as follows: + + ```bash + git config --system set autocrlf=false + ``` + + !!! tip "Feel free to reach out in the [Hack for LA Slack channel](https://hackforla.slack.com/messages/people-depot/) if you encounter any errors while running scripts on Windows" + +=== "Mac" + Please note that if you have a Mac the page offers several options (see other option, if you need to conserve hard drive space) including: + + - an “easiest” option (this version is fine for our use): This option would take just over 4GB. + - a “more up to date” option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew. + - Other option: If your computer is low on space, you can use this [tutorial](https://www.datacamp.com/community/tutorials/homebrew-install-use) to install XCode Command Tools and a lighter version of Homebrew and then install Git using this command: `$ brew install git` which in total only uses 300MB. + +### Install Docker + +Install or make sure [docker][docker-install] and [docker-compose][docker-compose-install] are installed on your computer + +```bash +docker -v +docker-compose -v +``` + +The recommended installation method for your operating system can be found [here](https://docs.docker.com/install/). + +!!! tip "Feel free to reach out in the [Hack for LA Slack channel](https://hackforla.slack.com/messages/people-depot/) if you have trouble installing docker on your system" + +More on using Docker and the concepts of containerization: + +- [Get started with Docker](https://docs.docker.com/get-started/) + +## Fork the repository + +You can fork the hackforla/peopledepot repository by clicking +. A fork is a copy of the repository that will be placed on your GitHub account. + +!!! note "It should create a URL that looks like the following -> `https://github.com//peopledepot`" + !!! example "For example -> `https://github.com/octocat/peopledepot`" + +!!! info "What you have created is a forked copy in a remote version on GitHub. It is not on your local machine yet" + +### Clone a copy on your computer + +The following steps will clone (create) a local copy of the forked repository on your computer. + +1. Create a new folder in your computer that will contain `hackforla` projects. + + In your command line interface (Terminal, Git Bash, Powershell), move to where you want your new folder to be placed and create a new folder in your computer that will contain `hackforla` projects. After that, navigate into the folder(directory) you just created. + + For example: + + ```bash + cd /projects + mkdir hackforla + cd hackforla + ``` + +1. From the hackforla directory created in previous section: + + ```bash + git clone https://github.com//peopledepot.git + ``` + + For example if your GitHub username was `octocat`: + + ```bash + git clone https://github.com/octocat/peopledepot.git + ``` + + !!! note "You can also clone using ssh which is more secure but requires more setup. Because of the additional setup, cloning using https as shown above is recommended" + +You should now have a new folder in your `hackforla` folder called `peopledepot`. Verify this by changing into the new directory: + +```bash +cd peopledepot +``` + +### Verify and set up remote references + +Verify that your local cloned repository is pointing to the correct `origin` URL (that is, the forked repo on your own GitHub account): + +```bash +git remote -v +``` + +You should see `fetch` and `push` URLs with links to your forked repository under your account (i.e. `https://github.com//peopledepot.git`). You are all set to make working changes to the project on your local machine. + +However, we still need a way to keep our local repo up to date with the deployed project. To do so, you must add an upstream remote to incorporate changes made while you are working on your local repo. Run the following to add an upstream remote URL & update your local repo with recent changes to the `hackforla` version: + +```bash +git remote add upstream https://github.com/hackforla/peopledepot.git +git fetch upstream +``` + +After adding the upstream remote, you should now see it if you again run `git remote -v` : + +```bash +origin https://github.com//peopledepot.git (fetch) +origin https://github.com//peopledepot.git (push) +upstream https://github.com/hackforla/peopledepot.git (fetch) +upstream https://github.com/hackforla/peopledepot.git (push) +``` + +## Build and run using Docker locally + +1. Make sure the Docker service is running + + === "Docker (Engine)" + ```bash + sudo systemctl status docker + ``` + + It will show `Active: active (running)` if it's running. + + === "Docker Desktop" + 1. Start Docker Desktop + 1. Run `docker container ls` to verify Docker Desktop is running. If it is not running you will get the message: `Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?` + +1. Create an .env.docker file from .env.docker-example + + ```bash + cp ./app/.env.docker-example ./app/.env.docker + ``` + +1. Build and run the project via the script (this includes running `docker-compose up`) + + ```bash + ./scripts/buildrun.sh + ``` + +1. Create a super user for logging into the web admin interface + + ```bash + docker-compose exec web python manage.py createsuperuser --no-input + ``` + +1. Browse to the web admin interface at `http://localhost:8000/admin/` and confirm the admin site is running. Use DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD from .env.docker for credentials. + +See our documentation for [Working with Docker](tools/docker.md#working-with-docker) for more useful Docker commands. + +## Install pre-commit + +This will check your changes for common problems. + +See the [Pre-commit page](tools/pre-commit.md) for installation instructions. + +For consistency, an automated bot will perform the same checks on the repository side when you open a pull request. + +[docker-compose-install]: https://docs.docker.com/compose/install/ +[docker-install]: https://docs.docker.com/get-docker/ diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md new file mode 100644 index 00000000..70f891f5 --- /dev/null +++ b/docs/contributing/documentation.md @@ -0,0 +1,5 @@ +# Documentation + +We highly encourage contributors to add and update documentation in the same pull request as the code. This will ensure that the docs and features are synchronized. + +Please see the [MkDocs page](tools/mkdocs.md) for how to view documentation changes locally using the mkdocs in docker. diff --git a/docs/contributing/git.md b/docs/contributing/git.md new file mode 100644 index 00000000..cba67115 --- /dev/null +++ b/docs/contributing/git.md @@ -0,0 +1,37 @@ +# Working with Git + +## Sync Main Changes + +Your fork of this repository on GitHub, and your local clone of that fork, will get out of sync with the (upstream) repository as others update the repository. (That's what has happened when you see something like "This branch is 1 commit behind peopledepot:main" on your forked repository.) + +One way to keep your fork up to date with this repository is to follow these instruction: [Syncing your fork to the original repository via the browser](https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser) + +You can also update your fork via the local clone of your fork, using these instructions. Assuming you have a local clone with remotes `upstream` (this repo) and `origin` (your GitHub fork of this repo): + +- First, you will need to create a local branch which tracks upstream/main. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes. + +Run the following two commands: + +```bash +git fetch upstream +git checkout -b upstream-main --track upstream/main +``` + +If you have already created the branch upstream-main, the following commands will incorporate upstream changes: + +```bash +git checkout upstream-main # Move to the branch you want to merge with. +git pull # This updates your tracking branch to match the main branch in this repository +git checkout main # Move back to your main branch +git merge upstream-main # Merge to bring your main current. +``` + +If you do all your work on topic branches (as suggested above) and keep main free of local modifications, this merge should apply cleanly. + +Then push the merge changes to your GitHub fork: + +```bash +git push +``` + +If you go to your online GitHub repository this should remove the message "This branch is x commit behind peopledepot:main". diff --git a/docs/contributing/howto/.pages b/docs/contributing/howto/.pages new file mode 100644 index 00000000..d6f5c6ed --- /dev/null +++ b/docs/contributing/howto/.pages @@ -0,0 +1,6 @@ +title: How-to Guides +nav: + - add-model-and-api-endpoints.md + - create-initial-data-migrations.md + - run-local.md + - ... diff --git a/docs/how-to/add-model-and-api-endpoints.md b/docs/contributing/howto/add-model-and-api-endpoints.md similarity index 96% rename from docs/how-to/add-model-and-api-endpoints.md rename to docs/contributing/howto/add-model-and-api-endpoints.md index ef67ac5c..6ddb7d17 100644 --- a/docs/how-to/add-model-and-api-endpoints.md +++ b/docs/contributing/howto/add-model-and-api-endpoints.md @@ -13,7 +13,7 @@ This guide aims to enable developers with little or no django experience to add - API design - command line -This guide assumes the developer has followed the [contributing doc](CONTRIBUTING.md) and have forked and created a local branch to work on this. The development server would be already running in the background and will automatically apply the changes when we save the files. +This guide assumes the developer has followed the [working with issues guide](issues.md) and have forked and created a local branch to work on this. The development server would be already running in the background and will automatically apply the changes when we save the files. We will choose the [recurring_event issue](https://github.com/hackforla/peopledepot/issues/14) as an example. Our goal is to create a database table and an API that a client can use to work with the data. The work is split into 3 testable components: the model, the admin site, and the API @@ -205,7 +205,7 @@ In `app/core/admin.py` Check that everything's working and there are no issues, which should be the case unless there's custom input fields creating problems. -1. See the [contributing doc section on "Build and run using Docker locally"](CONTRIBUTING.md#23-build-and-run-using-docker-locally) for how to view the admin interface. +1. See the [development setup guide section on "Build and run using Docker locally"](dev_environment.md#build-and-run-using-docker-locally) for how to view the admin interface. 1. Example of a custom field (as opposed to the built-in ones) @@ -441,10 +441,10 @@ In `app/core/api/urls.py` 1. Params 1. First param is the URL prefix use in the API routes. It is, by convention, plural - - This would show up in the URL like this: `http://localhost/api/v1/recuring-events/` and `http://localhost/api/v1/recuring-events/` + - This would show up in the URL like this: `http://localhost:8000/api/v1/recuring-events/` and `http://localhost:8000/api/v1/recuring-events/` 1. Second param is the viewset class which defines the API actions 1. `basename` is the name used for generating the endpoint names, such as -list, -detail, etc. It's in the singular form. This is automatically generated if the viewset definition contains a `queryset` attribute, but it's required if the viewset overrides that with the `get_queryset` function - - `reverse("recurring-event-list")` would return `http://localhost/api/v1/recuring-events/` + - `reverse("recurring-event-list")` would return `http://localhost:8000/api/v1/recuring-events/` ??? note "Test" For the CRUD operations, since we're using `ModelViewSet` where all the actions are provided by `rest_framework` and well-tested, it's not necessary to have test cases for them. But here's an example of one. @@ -508,4 +508,4 @@ In `app/core/api/urls.py` ``` ??? note "Push the code and start a PR" - Refer to the [contributing doc section on "Push to upstream origin"](CONTRIBUTING.md#410-push-to-upstream-origin-aka-your-fork) onward. + Refer to the [Issues page section on "Push to upstream origin"](issues.md#push-to-upstream-origin-aka-your-fork) onward. diff --git a/docs/how-to/create-initial-data-migrations.md b/docs/contributing/howto/create-initial-data-migrations.md similarity index 100% rename from docs/how-to/create-initial-data-migrations.md rename to docs/contributing/howto/create-initial-data-migrations.md diff --git a/docs/contributing/howto/index.md b/docs/contributing/howto/index.md new file mode 100644 index 00000000..5634bd1a --- /dev/null +++ b/docs/contributing/howto/index.md @@ -0,0 +1,7 @@ +# How-to Guides + +These are the developer guides for how to do specific things with the project. + +1. [Add model and API endpoints](add-model-and-api-endpoints.md) +1. [Create initial data migrations](create-initial-data-migrations.md) +1. [Run the project in a virtual environment](run-local.md) diff --git a/docs/how-to/run-local.md b/docs/contributing/howto/run-local.md similarity index 100% rename from docs/how-to/run-local.md rename to docs/contributing/howto/run-local.md diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 100644 index 00000000..4b887f43 --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1,23 @@ +# Contributing + +Thank you for volunteering your time! The following is a set of guidelines for contributing to the PeopleDepot repository, which is hosted on GitHub. + +**Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the [Getting Started Page](https://www.hackforla.org/getting-started).** _Workshop attendees are granted a temporary exception from this requirement._ + +- [Joining the team](team.md) + +- [Setting up the Development Environment](dev_environment.md) + + - [Pre-requisites](dev_environment.md#pre-requisites) + - [Fork the repository](dev_environment.md#fork-the-repository) + - [Build and run locally](dev_environment.md#build-and-run-using-docker-locally) + +- [Working with Issues](issues.md) + +- [Working with Git](git.md) + +- [Documentation](documentation.md) + +- [How-to Guides](howto/index.md) + +- [Tools](tools/index.md) diff --git a/docs/contributing/issues.md b/docs/contributing/issues.md new file mode 100644 index 00000000..71b167e3 --- /dev/null +++ b/docs/contributing/issues.md @@ -0,0 +1,155 @@ +# Working with Issues + +## Find an issue + +Find an issue in Prioritized Backlog [here](https://github.com/orgs/hackforla/projects/61/views/2) + +If you joined the PeopleDepot repository as described in a previous section: + +1. Assign the issue to yourself and move it to "In progress" column. +1. Follow the steps in the issue description to complete the issue. +1. Make sure to comment your ETA and Availability when you first assign yourself. + +If you don't have privileges, add a comment that you are working on the issue. + +## Create a new branch + +Once you have selected an issue to work on, create a branch for that issue. + +Verify you are on the `main` branch. + +```bash +git branch +``` + +You will see a list of all of your branches. There will be a star (`*`) next to the branch that you are currently in. By default you should start on the `main` branch. + +If you are not currently in the `main` branch, run the following command to return to it: + +```bash +git checkout main +``` + +```bash +git pull origin main +``` + +This ensures you have the most recent code, which is important if you previously cloned and it has been more than a day. + +Create a new branch where you will work on the issue. The branch name should include the issue number. For example, to create a new branch for issue 15 and change into it: + +```bash +git checkout -b -15 +``` + +## Make changes + +Make changes to fix the issue. + +## Pull to get the most recent code + +You can probably skip this if you fix the issue on the same day that you pulled the code. + +```bash +git pull +``` + +!!! note "If you are using Visual studios code you can use the Git graphical user interface to stage your changes. For instructions check out the [Git GUI page in the website Wiki]()" + +## Add changed files to staging + +**Make sure you are on your issue branch (instead of `main`)** + +```bash +git branch +``` + +You must add your files to the staging area before you can commit (save them to git). + +Run this command if you want to **add changes from a specific file to your commit record**: + +```bash +git add “filename.ext” +``` + +Run this command if you want to **add all changes to all file(s) to your commit record**: + +```bash +git add . +``` + +## Check Git status + +This command will list the files that have been staged with green text. These are the files that will be committed (saved) when you run the next command, `git commit`. Please be sure all your staged changes are relevant to the issue you are working on. If you accidentally included unrelated changes, please unstage them before making this commit, and then make a new commit for the unrelated changes. (The commands for unstaging commits are provided in the output of your `git status` command.) + +```bash +git status +``` + +## Remove files that you don't want staged + +This command will unstage a file that you don't want included in the commit. The specified file will not be committed (saved) when you run the next command, `git commit`. This only works if the wrong files were added, but they were not yet committed. (See [this tutorial](https://www.atlassian.com/git/tutorials/resetting-checking-out-and-reverting) for an in-depth discussion.) The file will be removed from the staging area, but not actually deleted: + +```bash +git reset HEAD “filename.ext” +``` + +## Commit staged changes + +This command saves your work, and prepares it to push to your repository. Use the `-m` flag to quickly add a message to your commit. Your message should be a short description of the changes you made. It will be extremely helpful if other people can understand your message, so try to resist the temptation to be overly cryptic. + +To commit your changes with a message, run: + +```bash +git commit -m “insert message here” +``` + +Ensure that your local repository is up-to-date with the main site: + +```bash +git pull upstream +``` + +You can also sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch" + +## Push to upstream origin (aka, your fork) + +Push your local branch to your remote repository: + +```bash +git push --set-upstream origin +``` + +Alternatively, you can run + +```bash +git push +``` + +## Create a pull request + +### Push all changes in your issue branch + +Once you are satisfied with your changes, push them to the feature branch you made within your remote repository. + +```bash +git push --set-upstream origin +``` + +### Complete pull request from GitHub + +1. Click the green button to create a Pull Request (PR) +1. Add a short title in the subject line +1. In the body of the comment, add the following, replacing `` with the issue you worked on: + +```bash +fixes # +``` + +1. Below this, add a brief description of the changes you made +1. Click the green "Create pull request" button +1. Add the PR to the project board + +# Creating Issues + +To create a new issue, please use the blank issue template (available when you click New Issue). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link. diff --git a/docs/contributing/team.md b/docs/contributing/team.md new file mode 100644 index 00000000..8d8c087a --- /dev/null +++ b/docs/contributing/team.md @@ -0,0 +1,8 @@ +# Joining Repository Team + +This step is optional if this is your first time fixing an issue and you want to try fixing an issue without this step. + +In the [People-depot Slack channel](https://hackforla.slack.com/messages/people-depot/), send an introductory message with your GitHub `handle/username` asking to be added to the Hack for LA peopledepot GitHub repository, have access to the Google Docs Drive, and Figma. + +!!! note "Please do the following once you have accepted the GitHub invite (comes via email or in your GitHub notifications)" + Make your own Hack for LA GitHub organization membership public by following this [guide](https://help.github.com/en/articles/publicizing-or-hiding-organization-membership#changing-the-visibility-of-your-organization-membership). diff --git a/docs/tools/.pages b/docs/contributing/tools/.pages similarity index 66% rename from docs/tools/.pages rename to docs/contributing/tools/.pages index 454d9d70..f2ee6a4a 100644 --- a/docs/tools/.pages +++ b/docs/contributing/tools/.pages @@ -1,4 +1,3 @@ nav: - scripts.md - - mkdocs.md - ... diff --git a/docs/tools/docker.md b/docs/contributing/tools/docker.md similarity index 85% rename from docs/tools/docker.md rename to docs/contributing/tools/docker.md index ac49299e..fe8b3a00 100644 --- a/docs/tools/docker.md +++ b/docs/contributing/tools/docker.md @@ -1,5 +1,43 @@ # Docker +## Working with Docker + +### Stopping Docker + +To stop the service-container, but not destroy it (often sufficient for day-to-day work): + +```bash +docker-compose stop +``` + +To stop and destroy the service container: + +```bash +docker-compose down +``` + +Add the `-v` flag to destroy the data volumes as well: + +```bash +docker-compose down -v +``` + +### Recycling / Refreshing Database + +To restore a database to its original state and remove any data manually added, delete the container and image. +From Docker: + +=== "Terminal" + ```bash + docker-compose down -v + ``` + +=== "Docker Desktop" + 1. Open Containers section + 1. Delete people-db-1 container + 1. Open Images Tab + 1. Remove djangorestapipostrgresql image + ## Cache mount This helps speed up subsequent docker builds by caching intermediate files and reusing them across builds. It's available with docker buildkit. The key here is to disable anything that could delete the cache, because we want to preserve it. The cache mount is not going to end up in the docker image being built, so there's no concern about disk space usage. diff --git a/docs/contributing/tools/index.md b/docs/contributing/tools/index.md new file mode 100644 index 00000000..be7f9d1a --- /dev/null +++ b/docs/contributing/tools/index.md @@ -0,0 +1,9 @@ +# Tools + +These are the tools we use in the PeopleDepot project with notes on how we use them. + +- [Convenience scripts](scripts.md) +- [Docker](docker.md) for containerization +- [MkDocs](mkdocs.md) for documentation +- [Pre-commit](pre-commit.md) for linting +- [Uv](uv.md) for fast dependency resolution diff --git a/docs/tools/mkdocs.md b/docs/contributing/tools/mkdocs.md similarity index 100% rename from docs/tools/mkdocs.md rename to docs/contributing/tools/mkdocs.md diff --git a/docs/tools/pre-commit.md b/docs/contributing/tools/pre-commit.md similarity index 100% rename from docs/tools/pre-commit.md rename to docs/contributing/tools/pre-commit.md diff --git a/docs/tools/scripts.md b/docs/contributing/tools/scripts.md similarity index 100% rename from docs/tools/scripts.md rename to docs/contributing/tools/scripts.md diff --git a/docs/tools/uv.md b/docs/contributing/tools/uv.md similarity index 100% rename from docs/tools/uv.md rename to docs/contributing/tools/uv.md diff --git a/docs/how-to/.pages b/docs/how-to/.pages deleted file mode 100644 index 74adc943..00000000 --- a/docs/how-to/.pages +++ /dev/null @@ -1 +0,0 @@ -title: Developer Guides diff --git a/scripts/createsuperuser.sh b/scripts/createsuperuser.sh index 9f7ffdb4..8c299a9d 100755 --- a/scripts/createsuperuser.sh +++ b/scripts/createsuperuser.sh @@ -8,5 +8,5 @@ set -x # This command requires the DJANGO_SUPERUSER_USERNAME and # DJANGO_SUPERUSER_PASSWORD environmental variables to be set when django starts -echo "DJANGO_SUPERUSER_USERNAME: $DJANGO_SUPERUSER_USERNAME" +# echo "DJANGO_SUPERUSER_USERNAME: $DJANGO_SUPERUSER_USERNAME" docker-compose exec web python manage.py createsuperuser --no-input diff --git a/scripts/rebase_migration.sh b/scripts/rebase_migration.sh new file mode 100755 index 00000000..5ee06e80 --- /dev/null +++ b/scripts/rebase_migration.sh @@ -0,0 +1,6 @@ +#!/bin/bash +set -euo pipefail +IFS=$'\n\t' + +set -x +docker-compose exec web python manage.py rebase_migration core