Skip to content

final.md

Latest commit

 

History

History
60 lines (37 loc) · 2.74 KB

final.md

File metadata and controls

60 lines (37 loc) · 2.74 KB

Final Assignment

The goal of the final project is to make an open source contribution. This can be something quite small, even just a single page of documentation, one new code example, a single dataset.

Options

Contribute to an existing project

You can contribute to any of the open source projects covered during the course, or find one you'd like to contribute to. Contributions don't have to be code. Some ideas:

  • Fix or improve a documentation or reference page (e.g. ml5.js, p5.js)
  • Add or correct a translation
  • File a researched bug report
  • Contribute a dataset to Corpora

Start your own project

You can also create your own open source project. It doesn't have to be code and it doesn't have to be large. Some ideas:

  • An open source dataset
  • Open source design assets
  • A collection of code examples. This could be new code examples or translations of existing ones to another language or framework (for example Nature of Code examples)
  • An openly licensed curriculum, lesson plan, or tutorial

If you are creating your own project, at a minimum your repository should include:

  • README.md — describe what the project is, how to use it, and how to contribute
  • LICENSE — choose an open source license (see choosealicense.com)

Stages

1: Proposal Presentations, 4/20

Come to class ready to present your proposal. Before class:

  • If you are contributing to an existing project: File an issue or comment on an existing issue in the project you plan to contribute to. Write a short proposal describing what you plan to do and link to the issue below.
  • If you are starting your own project: Create a repository with at least a README.md. Write a short proposal describing what the project is and what you plan to do with it, and link to the repo below.

Pull request a link to your proposal below:

2: Development Studio, 4/27

Work session. Come with progress to share and questions to discuss.

3: Presentations, 5/4

Present your contribution to the class. Document your process. This could be a blog post, a README, a video, or any other format that captures what you did and what you learned. Consider addressing:

  • Describe your open source contribution.
  • How did your idea change from your initial proposal?
  • What did you learn?
  • How did you get feedback on your contribution?
  • Do you plan to continue working on this?
  • How do you feel about contributing to open source in the future?

Pull request a link to your documentation below: