(minor) fix formatting; add "upvoting" to cSpell.json

This commit is contained in:
Ashley Engelund (weedySeaDragon @ github)
2022-11-18 09:37:57 -08:00
parent acebcbffc8
commit a867400d56
2 changed files with 7 additions and 4 deletions

View File

@@ -72,6 +72,7 @@
"techn",
"ts-nocheck",
"tuleap",
"upvoting",
"verdana",
"viewports",
"vinod",

View File

@@ -1,6 +1,7 @@
# Contributing to Mermaid
## Contents
- [Technical Requirements and Setup](#technical-requirements-and-setup)
- [Contributing Code](#contributing-code)
- [Contributing Documentation](#contributing-documentation)
@@ -18,6 +19,7 @@ Here are a few things to get you started on the right path.
## Technical Requirements and Setup
### Technical Requirements
These are the tools we use for working with the code and documentation.
- [volta](https://volta.sh/) to manage node versions.
@@ -62,7 +64,7 @@ pnpm test
The `test` script and others are in the top-level `package.json` file.
All tests should run sucessfully without any errors or failures. (You might see _lint_ or _formatting_ warnings; those are ok during this step.)
All tests should run sucessfully without any errors or failures. (You might see _lint_ or _formatting_ warnings; those are ok during this step.)
## Contributing Code
@@ -187,7 +189,7 @@ The documentation has to be updated to users know that things have changed and a
We know it can sometimes be hard to code _and_ write user documentation.
_**[TODO - how to submit documentation changes.** A few words plus a link to [Contributing Documentation](#contributing-documentation)_
_**[TODO - how to submit documentation changes.** A few words plus a link to [Contributing Documentation](#contributing-documentation)_
Create another issue specifically for the documentation.
You will need to help with the PR, but definitely ask for help if you feel stuck.
@@ -276,7 +278,7 @@ To edit Docs on GitHub:
- search in the open Issues
If you find an open issue or discussion thread that is similar to your question but isn't answered,
you can let us know that you are also interested in it. **_[TODO: describe upvoting]_**
you can let us know that you are also interested in it. **_[TODO: describe upvoting]_**
This helps the team know the relative interest in something and helps them set priorities and assignments.
Feel free to add to the discussion on the issue or topic.