CONTRIBUTOR GUIDE

# Contributor Guidelines Hey there 👋 So, you have decided to start off a brand new ***Glossary Journey***... The **objectives** of any `glossary` are to: 1. Provide readers with **accurate** and **concise** information about **what they wish to know**, 2. provide a reference needed to navigate Readers to Docs and proceed accordingly, and 3. provide the knowledge **quickly**, in a **digestable** format. **It is important to note that the glossary is not a substitute for the Astro documentation. Instead, it aims to provide a clear and concise definition, as an entry-point or as supplementary information for anyone who wants to `launch` into using Astro or contributing to documentation.** Within this HackMD workspace, there are a couple notes you should read to write a useful contribution. - The [`GLOSSARY AUDIENCE`](/orrzZ-qYTcKVV89i4Zh5hw), and - The [`GLOSSARY FORMAT`](/1jxXlVBuT-WdQSOx7q8nTw). The former describes who we are writing for. This is important because, as writers, we must always consider our audience, so that we may understand what is important and what is not. The latter describes a set of rules by which you should abide when writing a `glossary entry`. ## Making a Note **You can contribute to the `glossary` by adding terms and joining the discussion!** To add a new term entry, you can click the `New team note` button on the dashboard. Then, label it as an `entry` by clicking the little label icon next to the note's name in the top middle of the screen. Your note's name should follow this convention: `entry: <TERM>`. Assuming you are on Astro's Discord server, you can join us in discussion [here](https://discord.com/channels/830184174198718474/1177958355189387294). This is where you can ask questions, request review, and just talk with us! There are also some discussion notes here in HackMD. Feel free to peruse them and join in! ## Editing Other Notes and Getting Approval The team leads for the `glossary` project are @Voxel, @Atharva, and @genteure. They are responsible for auditing and organizing every note entry. Here are their guidelines for fuss-free editing of other people's notes. 1. **Let the note author make final changes**. Treat this somewhat like a GitHub PR. Please follow [these guidelines](#Editing-Guidelines) so that good work isn't ever overwritten. 2. **If you need help choosing the best words, just ask!** We are all eager to help each other write great documentation. 3. The leads are responsible for choosing which terms are added to the final glossary. **If you think a term should be included, make the note and add it -- even if it may not be in the final version.** Every bit helps, and every contribution builds a better glossary in the end. 4. **When you think a note is ready and final, let the leads know so we can cross `t`'s and dot `i`'s!** 5. **Perfection is not necessary.** If it *is* attainable, don't worry about it on the first try. The power of collaboration will ensure that each entry is as good as it can be. ### Editing Guidelines **Remember:** Don't change the author's text. Add your changes like below, so the author (or a team lead) can accept or reject them. If you would rather, HackMD also offers a commenting feature. To use this, you can highlight text in the preview pane, and click comment to give your feedback. You may use whichever is more comfortable for you! #### Examples **For single changes:** > Remove `___` [name=Voxel][color=red] > Add `___` [name=Voxel][color=green] > Modify/change `___` to `___` [name=Voxel][color=gold] **For multiple changes:** > [name=Voxel][color=blue]**Review:** > Remove `___` > Add `___` > ... ## Supplemental Material > [color=lightblue] You can find the running PR(s) for glossary to review/ take notes from here: [Astro Docs PRs with the `glossary` label](https://github.com/withastro/docs/pulls?q=is%3Apr+label%3Aglossary+is%3Aopen)