Skip to content

Commit

Permalink
Merge pull request #58 from code4policy/master
Browse files Browse the repository at this point in the history
Master
  • Loading branch information
aarushisahejpal authored Jan 5, 2025
2 parents 75be51a + 4a088a5 commit c5f9b5a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 18 deletions.
3 changes: 0 additions & 3 deletions agile/06-reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
- [Elements of Scrum](https://www.amazon.com/Elements-Scrum-Chris-Sims-ebook/dp/B004O0U74Q/ref=sr_1_2?s=digital-text&ie=UTF8&qid=1546492282&sr=1-2&keywords=elements+of+scrum) [Part I and Part II]
- (Go ahead and read the whole thing if you find yourself interested, its not too long)

**Due Friday**
- Healthcare.gov Case Part A (provided on Slack) - Read by Friday

## Additional Resources

A shorter alternative to "Elements of Scrum" (in case you run out of time)
Expand Down
15 changes: 8 additions & 7 deletions apis/apireadings.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## Reading
* **(required)** [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up): Chapter 1 -"Introduction: A Programmable Web"
* **(required)** [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up): Chapter 2 -"Building for Users: Designing URLs"
* **(recommended)** [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up): Chapter 3 -"Building for Search Engines: Following Rest"
* **(required)** [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up): Chapter 5 -"Building a Platform: Providing APIs"
* [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up): Rest of the book is not required, but Chapter 7 is about Open Source if you're interested.
* **(required)** APIs that suck [video] - [https://www.infoq.com/presentations/API-design-mistakes]

Additioanl Resources
* [Aaron Swartz’s A Programmable Web](https://archive.org/details/AaronSwartzAProgrammableWeb/page/n3/mode/2up)
* "Building for Users: Designing URLs" Chapter 2 (p 9-13) ;
* "Building for Search Engines: Following Rest" Chapter 3 (all);
* "Building a Platform: Providing APIs"Chapter 5 (p 31-36)
* Rest of the book is not required, but Chapter 7 is about Open Source if you're interested.

Additional Resources (Optional)
* APIs that suck [video] - https://www.infoq.com/presentations/API-design-mistakes
* [REST API Design - Resource Modeling](https://www.thoughtworks.com/insights/blog/rest-api-design-resource-modeling) (Thoughtworks)
* [https://micropurchase.18f.gov/](https://micropurchase.18f.gov/)
* Programmable Web - [https://www.programmableweb.com/about](https://www.programmableweb.com/about)
Expand Down
16 changes: 8 additions & 8 deletions git/12-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ When working with branches, here is the general workflow to adhere to.
1. Before starting work:

```bash
# always start your branching from the master branch
git checkout master
# always start your branching from the main branch
git checkout main

# pull the latest
git pull

# create a new branch, branch-ed off of the master branch
# create a new branch, branch-ed off of the main branch
git checkout -b my-awesome-feature
```

Expand All @@ -33,13 +33,13 @@ When working with branches, here is the general workflow to adhere to.
git push
```

3. Also make sure to periodically pull from master:
3. Also make sure to periodically pull from main:

```bash
git pull origin master
git pull origin main
```

**Pulling from master periodically is very important!** This will keep your code relatively in-sync and prevent deferring massive merge conflicts down the line.
**Pulling from main periodically is very important!** This will keep your code relatively in-sync and prevent deferring massive merge conflicts down the line.

4. When you're done with your work
Expand All @@ -50,15 +50,15 @@ When working with branches, here is the general workflow to adhere to.
git status
```

then open up GitHub and **issue a pull request back to master**.
then open up GitHub and **issue a pull request back to main**.

## Workflow Types

### Feature Branches (recommended)

![](https://i.imgur.com/T6pJPY8.jpg)

The feature branch workflow is where every small or large feature gets its own branch. These branches are shortlived and are quickly merged back into master. Each feature branch corresponds to a pull request and the branch is deleted after the PR is merged.
The feature branch workflow is where every small or large feature gets its own branch. These branches are shortlived and are quickly merged back into main. Each feature branch corresponds to a pull request and the branch is deleted after the PR is merged.

### Team Member Branches

Expand Down

0 comments on commit c5f9b5a

Please sign in to comment.