Skip to content

Commit

Permalink
remove all header numbering
Browse files Browse the repository at this point in the history
These can be auto-generated if needed
  • Loading branch information
fyliu committed Oct 17, 2024
1 parent a889b08 commit 03abc8b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 29 deletions.
22 changes: 11 additions & 11 deletions docs/contributing/dev_environment.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## 2. Setting Up Development Environment
# Setting Up Development Environment

### 2.1 Pre-requisites
## Pre-requisites

#### 2.1.1 GitHub account
### 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
### 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
### 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
### 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).

Expand All @@ -38,7 +38,7 @@ Before cloning your forked repository to your local machine, you must have Git i
- 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 Docker

Install or make sure [docker][docker-install] and [docker-compose][docker-compose-install] are installed on your computer

Expand All @@ -55,7 +55,7 @@ More on using Docker and the concepts of containerization:

- [Get started with Docker](https://docs.docker.com/get-started/)

### 2.2 Fork the repository
## Fork the repository

You can fork the hackforla/peopledepot repository by clicking <a href="https://github.com/hackforla/peopledepot/fork"> <button> <img src="https://user-images.githubusercontent.com/17777237/54873012-40fa5b00-4dd6-11e9-98e0-cc436426c720.png" width="8px"> Fork</button></a>
. A fork is a copy of the repository that will be placed on your GitHub account.
Expand All @@ -65,7 +65,7 @@ You can fork the hackforla/peopledepot repository by clicking <a href="https://g

!!! 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
### Clone a copy on your computer

The following steps will clone (create) a local copy of the forked repository on your computer.

Expand Down Expand Up @@ -101,7 +101,7 @@ You should now have a new folder in your `hackforla` folder called `peopledepot`
cd peopledepot
```

#### 2.2.2 Verify and set up remote references
### 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):

Expand All @@ -127,7 +127,7 @@ upstream https://github.com/hackforla/peopledepot.git (fetch)
upstream https://github.com/hackforla/peopledepot.git (push)
```

### 2.3 Build and run using Docker locally
## Build and run using Docker locally

1. Make sure the Docker service is running

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/documentation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 5. Documentation
# 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/git.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 6. Sync Main Changes
# 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.)

Expand Down
30 changes: 15 additions & 15 deletions docs/contributing/issues.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 4. Fixing Issues
# Fixing Issues

### 4.1 Find an issue
## Find an issue

Find an issue in Prioritized Backlog [here](https://github.com/hackforla/peopledepot/projects/1#column-16900748)

Expand All @@ -12,7 +12,7 @@ If you joined the peopledepot repository as described in a previous section:

If you don't have privileges, add a comment that you are working on the issue.

### 4.2 Create a new branch
## Create a new branch

Once you have selected an issue to work on, create a branch for that issue.

Expand Down Expand Up @@ -42,11 +42,11 @@ Create a new branch where you will work on the issue. The branch name should inc
git checkout -b <new-branch-name>-15
```

### 4.3 Make changes
## Make changes

Make changes to fix the issue.

### 4.4 Pull to get the most recent code
## 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.

Expand All @@ -56,7 +56,7 @@ 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](<https://github.com/hackforla/website/wiki/How-to-Use-Git-GUI-(Graphical-user-Interface)-in-Visual-Studios-Code>)"

### 4.5 Add changed files to staging
## Add changed files to staging

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

Expand All @@ -78,31 +78,31 @@ Run this command if you want to **add all changes to all file(s) to your commit
git add .
```

### 4.6 Check Git status
## 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
## 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
## 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
## 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.

Expand All @@ -120,7 +120,7 @@ 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 to upstream origin (aka, your fork)

Push your local branch to your remote repository:

Expand All @@ -134,17 +134,17 @@ Alternatively, you can run
git push
```

### 4.11 Create a pull request
## Create a pull request

#### 4.11.1 Push all changes in your issue branch
### 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 <name-of-branch>
```

#### 4.11.2 Complete pull request from GitHub
### 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
Expand All @@ -158,6 +158,6 @@ fixes #<issue-number>
1. Click the green "Create pull request" button
1. Add the PR to the project board

## 7. Creating Issues
# 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.
2 changes: 1 addition & 1 deletion docs/contributing/team.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 1. Joining Repository Team
# 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.

Expand Down

0 comments on commit 03abc8b

Please sign in to comment.