Skip to content

Latest commit

 

History

History
427 lines (266 loc) · 17.1 KB

CONTRIBUTING.md

File metadata and controls

427 lines (266 loc) · 17.1 KB
Raw

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. Workshop attendees are granted a temporary exception from this requirement.

1. 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 hfla-site 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: Once you have accepted the GitHub invite (comes via email or in your GitHub notifications), please do the following:

Make your own Hack for LA GitHub organization membership public by following this guide.

2. Setting Up Development Environment

2.1 Pre-requisites

2.1.1 GitHub account

See here for creating a GitHub account. If you are not familiar with Git, this tutorial is recommended.

2.1.2 Two-factor authentication

Set up two-factor authentication on your account by following this guide.

2.1.3 Text editor

VS Code 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.

Installation Guide for Windows Users

  • we recommend installing Windows Subsystem for Linux (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:
git config --system set autocrlf=false

Feel free to reach out in the Hack for LA Slack channel if you encounter any errors while running scripts on Windows.

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 use at hackforla): 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 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 and docker-compose are installed on your computer

docker -v
docker-compose -v

The recommended installation method for your operating system can be found here. Feel free to reach out in the Hack for LA Slack channel if you have trouble installing docker on your system

More on using Docker and the concepts of containerization:

2.2 Fork the repository

You can fork the hackforla/peopledepot repository by clicking Fork . 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/<your_GitHub_user_name>/peopledepot.

For example -> https://github.com/octocat/peopledepot.

Be Aware: What you have created is a forked copy in a remote version on GitHub. It is not yet 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:

cd /projects
mkdir hackforla
cd hackforla
  1. From the hackforla directory created in previous section:
git clone https://github.com/<your_GitHub_user_name>/peopledepot.git

For example if your GitHub username was octocat:

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:

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):

git remote -v

You should see fetch and push URLs with links to your forked repository under your account (i.e. https://github.com/<your_GitHub_user_name>/peopledepot.git). You are all set to make working changes to the website on your local machine.

However, we still need a way to keep our local repo up to date with the deployed website. 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:

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 :

origin  https://github.com/<your_GitHub_user_name>/peopledepot.git (fetch)
origin  https://github.com/<your_GitHub_user_name>/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. Start Docker Desktop

  2. 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?

  3. Create an .env.docker file from .env.docker-example

    cp .env.docker-example .env.docker

  4. Build and run the project via the script (this includes running docker-compose up)

    ./scripts/buildrun.sh

  5. Create a super user for logging into the web admin interface

    docker-compose exec web python manage.py createsuperuser --no-input

  6. 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):

docker-compose stop

To stop and destroy the service container:

docker-compose down

Add the -v flag to destroy the data volumes as well:

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:

  1. Open Containers section
  2. Delete people-db-1 container
  3. Open Images Tab
  4. Remove djangorestapipostrgresql image

4. Fixing Issues

4.1 Find an issue

Find an issue in Prioritized Backlog here

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.
  2. Follow the steps in the issue description to complete the issue.
  3. 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.

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:

git checkout main
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:

git checkout -b <new-branch-name>-15

4.3 Make changes

Make changes to fix the issue.

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.

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 Wiki.

4.5 Add changed files to staging

Make sure you are on your issue branch (instead of main)

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:

git add “filename.ext”

Run this command if you want to add all changes to all file(s) to your commit record:

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.)

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 for an in-depth discussion.) The file will be removed from the staging area, but not actually deleted:

git reset HEAD “filename.ext”

4.8 Install pre-commit

This will check your changes for common problems.

See the Pre-commit page 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:

git commit -m “insert message here”

Ensure that your local repository is up-to-date with the main site:

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"

Click here to see how to sync the fork on GitHub

4.10 Push to upstream origin (aka, your fork)

Push your local branch to your remote repository:

git push --set-upstream origin <your-branch-name>

Alternatively, you can run

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.

git push --set-upstream origin <name-of-branch>

4.11.2 Complete pull request from GitHub

  1. Click the green button to create a Pull Request (PR)
  2. Add a short title in the subject line
  3. In the body of the comment, add the following, replacing <issue-number> with the issue you worked on:
fixes #<issue-number>
  1. Below this, add a brief description of the changes you made
  2. Click the green "Create pull request" button
  3. 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 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

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:

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:

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:

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: