Skip to content

Commit

Permalink
more ideas for explore and build and allow collaborative build
Browse files Browse the repository at this point in the history
  • Loading branch information
brownsarahm committed Sep 23, 2023
1 parent 3abdf12 commit 79905bc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
13 changes: 9 additions & 4 deletions activities/build.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Build Badges

```{warning}
This page is subject to change until the end of the penalty free zone
```
Build may be individual or in pairs.

## Proposal Template

Expand Down Expand Up @@ -53,14 +51,21 @@ This summary report have the following sections.
1. **Reflection** a one paragraph reflection that summarizes challenges faced and what you learned doing your project
1. **Artifacts** links to other materials required for assessing the project. This can be a public facing web resource, a private repository, or a shared file on URI google Drive.

## Collaborative Build rules/procedures

- Each student must submit a proposal PR for tracking purposes. The proposal may be shared text for most sections but the deliverables should indicate what each student will do (or be unique in each proposal).
- the proposal must indicate that it is a pair project, if iteration is required, I will put those comments on both repos but the students should discuss and reply/edit in collaboration
- the project must include code reviews as a part of the workflow links to the PRs on the project repo where the code reviews were completed should be included in the reflection
- each student must complete their own reflection. The abstract can be written together and shared, but the reflection must be unique.


## Build Ideas


- make a [vs code extension](https://code.visualstudio.com/api/get-started/your-first-extension) for this class or another URI CS course
- port the courseutils to rust. [crate clap](https://docs.rs/clap/latest/clap/) is like the python click package I used to develop the course utils
- buld a polished documentation website for your CSC212 project with [sphinx](https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/) or another static site generator
-
- use version control, including releases on any open source side-project and add good contributor guidelines, README, etc


<!--
Expand Down
3 changes: 2 additions & 1 deletion activities/explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ The exact length can vary, but these must go beyond what we do in class in scope
- Learn a lot more about a specific number system
- compare another git host
- try a different type of version control
- Create a visual aid/memory aid to help remember a topic. Draw inspriation from Wizard Zines or
- Create a visual aid/memory aid to help remember a topic. Draw inspriation from [Wizard Zines](https://wizardzines.com/)
- Review a reference or resource for a topic
- write a code tour that orients a new contributor to a past project or an open source tool you like.

Examples from past students:
````{margin}
Expand Down

0 comments on commit 79905bc

Please sign in to comment.