How to guide: Definition intake request

Hi there 👋 , thanks for taking interest in Glosseta and taking the initiative to help demystify web3! This page will provide a step by step overview of how to add a term through a Definition Intake Request found in the open issues tab.

Intake process

When somebody creates a Definition Intake Request, they can come in two flavours: a term with a definition or a term needing research to come up with a definition. If an issue has the label research needed that signifies that the given term in the request does not have a definition and needs to be researched by the assignee. The aim is to come up with a concise 2-3 sentence definition of the given term so that people reading it can gain a high level understanding of the topic.

If the issue already has a definition, you can pick it up and proceed to add the definition as highlighted below.

Note: Definitions submitted are reviewed for accuracy/spelling upon their submission as an issue and PR by the maintainers/reviewers

How to add a definition to Glosseta

1. Fork the repo
2. Create a branch on the forked repo naming it with some context around what your adding i.e. definition/adds-ethereum
3. Open the project and if it's your first time interacting with the app run through the steps in the Getting started section of the readme to get up and running
4. Open the master csv file located in resources/master_term_bank_en.csv
5. Observe the make up of each row in the CSV (more details of what each field represents can be found here) and then add your row at the bottom of the file matching the same format as those before it. Note the category field of your term can be found at the bottom of your assigned issue.
6. Open the termConfig.ts file and add the term to the end of the array. This array is used to power the search filter for the time being.
7. Now test out your changes by running yarn dev and traversing to the glossary page: localhost:3000/glossary
8. Find your term and make sure that it aligns with the expectations: term is there, definition matches, category tag appears below
9. If there are issues, correct them repeat step 7-8.
10. If everything looks good, then process to commit your changes and push them to the repo for review. Please tag @narbs91 as the reviewer.

The term(s) need to be uploaded to the Arweave protocol before we can officially merge the PR so they can show up when someone actually searches. This is in contrast to how the Glossary page works since it is populated from the master CSV for performance reasons.