Skip to content

Commit

Permalink
Merge pull request #117 from ryansurf/faq_update
Browse files Browse the repository at this point in the history
faq!
  • Loading branch information
ryansurf authored Aug 12, 2024
2 parents 57904d3 + 6fca339 commit 33310ab
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
# FAQ

FAQ coming soon...
<details>
<summary>What if I don't have <code>make</code> installed on my machine?</summary>
<br>
You can refer to the <a href="https://github.com/ryansurf/cli-surf/blob/main/makefile">Makefile</a>.
Instead of running a command like <code>make run</code>, you can run the command below it: <code>poetry run python src/server.py</code>
</details>
<br>

<details>
<summary>What do I do if the linter fails?</summary>
<br>
If the linter fails, you can run <code>make format</code>, which may fix the issues for you! If not, it will tell you
what needs to be fixed in the output.
</details>
<br>

<details>
<summary>What do I do if pytest fails?</summary>
<br>
If pytest fails, make sure you haven't broken anything unintentionally. Often, new changes in code will result in the unit tests breaking. Functions may now be returning different values/types which the tests do not expect. Please, try to debug any tests you may have broken!
</details>
<br>

<details>
<summary>The project doesn't work on my machine. What should I do?</summary>
<br>
cli-surf is a new project, and things break. If you come across any bugs, please submit an <a href="https://github.com/ryansurf/cli-surf/issues/new">issue!</a>
</details>
<br>

<details>
<summary>What is the purpose of this project?</summary>
<br>
I had a small spare monitor that could only display a terminal screen, so I used it to display the weather via <a href="https://github.com/chubin/wttr.in">wttr.in</a>. I like to surf,
and figured it would be useful to display surf data along with the weather. That is where I got the idea for cli-surf!
</details>
<br>

<details>
<summary>I have a question about contributing.</summary>
<br>
Please refer to the <a href="https://github.com/ryansurf/cli-surf/blob/main/CONTRIBUTING.md">contributing</a> file, or ask a question on the Discord/Discussions page.
</details>
<br>

1 comment on commit 33310ab

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py119794%32–36, 54, 76–77, 109–110
   art.py9367%32–33, 36
   cli.py250100% 
   dev_streamlit.py37370%1–86
   gpt.py10640%16–21, 32–45
   helper.py1243869%110, 121–125, 201–209, 221, 234–235, 266, 268–269, 292–293, 356–366, 373–381
   send_email.py24240%5–48
   server.py471079%55, 68–71, 87–91, 103–105
   settings.py220100% 
   streamlit_helper.py33330%5–90
TOTAL45015865% 

Tests Skipped Failures Errors Time
11 0 💤 0 ❌ 0 🔥 19.812s ⏱️

Please sign in to comment.