Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.19 KB

File metadata and controls

47 lines (31 loc) · 2.19 KB

Contribute to Cherry on Tech website

This is an open source website, currently licensed under the MIT license. While most of the website is a chance for squad members to learn together and show our skills, we welcome certain contributions. You can contribute to our dictionary, or by making a bug report. For installation instructions, see our README.md file.

Contribute to bug reports

We always welcome you to submit a bug report if you see something wrong or confusing on the website.

Contribute to our Tech Dictionary

We also welcome contributions to our tech dictionary.

What is the Tech Dictionary?

We have created a dictionary of tech terms that we think will help squad members and community members alike. We know that tech terms can have many meanings, depending on your point of view. In response, our tech dictionary explains terms from different perspectives.

How do I contribute?

Video Tutorial: https://www.youtube.com/watch?v=I7WsK5amUTA

  1. Navigate to the Dictionary page of our website, and find an entry you would like contribute to.
  2. If you see a dictionary entry on our site that does not yet have a definition, you may submit a pull request to address it. Here's how we think about the dictionary entries:
  • If a term probably only has one meaning, then we give it a definition.
  • If a term could mean different things to different roles, then we give it one or more perspectives.

All entries must be written in the following format, so that they can be processed properly. Please note that admins may edit the entry for clarity and/or formatting.

Tech Dictionary example

---
title: naptime
definition: A nap is a short period of sleep.
sources:
- sourceurl: https://example.com/things-i-need/naptime
perspectives:
- meaning: a terrible time when I can't play anymore
  role: child
- meaning: a wonderful time when I get a break
  role: parent

---

Note: Please write a definition as a complete sentence. Write the perspective's meaning with no puncuation or capitalization.